Module perimeta

Adapter module for perimeta’s REST API

• License: Inmanta EULA

• Version: 0.4.1

Typedefs

typedef perimeta::account::account_account_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::account::account_limits_call_appearances_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_call_setup_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::account_limits_call_setup_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_call_setup_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_call_setup_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::account_limits_call_setup_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_call_setup_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_direction_t

• Base type string

• Type constraint (self in ['both-ways', 'as-source', 'as-destination'])

typedef perimeta::account::account_limits_in_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::account_limits_in_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_in_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_in_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::account_limits_in_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_in_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::account::account_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_out_of_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::account_limits_out_of_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_out_of_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_out_of_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::account_limits_out_of_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_out_of_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_registrations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_regs_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::account_limits_regs_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_regs_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::account_limits_regs_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::account_limits_regs_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::account_limits_regs_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::call_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::account::call_limits_max_call_duration_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::account::call_limits_max_media_renegotiations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::call_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::call_media_policy_active_call_bypass_t

• Base type string

• Type constraint (self in ['allow', 'forbid'])

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_max_size_t

• Base type int

• Type constraint ((self >= 1) and (self <= 8000))

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_min_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_step_rate_t

• Base type int

• Type constraint ((self >= 1) and (self <= 100))

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_step_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::call_media_policy_all_calls_jitter_buffer_t

• Base type string

• Type constraint (self in ['off', 'fixed', 'adaptive'])

typedef perimeta::account::call_media_policy_bandwidth_policing_mode_t

• Base type string

• Type constraint (self in ['remove-streams', 'reject-calls', 'reduce-bandwidth'])

typedef perimeta::account::call_media_policy_comfort_noise_codec_t

• Base type string

• Type constraint (self in ['interwork', 'passthrough'])

typedef perimeta::account::call_media_policy_early_media_p_early_media_t

• Base type string

• Type constraint (self in ['passthrough', 'drop', 'calling', 'called', 'both'])

typedef perimeta::account::call_media_policy_early_media_timeout_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2000000))

typedef perimeta::account::call_media_policy_fax_transcoding_default_pcm_type_t

• Base type string

• Type constraint (self in ['pcmu', 'pcma'])

typedef perimeta::account::call_media_policy_fax_transcoding_generate_reinvite_t

• Base type string

• Type constraint (self in ['disabled', 'enabled', 'on-cng'])

typedef perimeta::account::call_media_policy_fax_transcoding_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4000))

typedef perimeta::account::call_media_policy_fax_transcoding_t

• Base type string

• Type constraint (self in ['disabled', 'pcm', 't38'])

typedef perimeta::account::call_media_policy_fax_transcoding_tone_detection_mode_t

• Base type string

• Type constraint (self in ['on-transcode', 'on-fax-mode'])

typedef perimeta::account::call_media_policy_force_ptime_t

• Base type string

• Type constraint (self in ['specify', 'dynamic'])

typedef perimeta::account::call_media_policy_force_ptime_value_t

• Base type int

• Type constraint ((self >= 10) and (self <= 200))

typedef perimeta::account::call_media_policy_hold_indicator_t

• Base type string

• Type constraint (self in ['hold-c0-a-line', 'hold-c0-inactive', 'hold-c0-sendonly', 'hold-c0', 'hold-sendonly', 'hold-inactive', 'hold-no-c0'])

typedef perimeta::account::call_media_policy_ice_lite_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::account::call_media_policy_inband_tone_interworking_t

• Base type string

• Type constraint (self in ['never', 'on-transcode', 'always'])

typedef perimeta::account::call_media_policy_inband_tones_t

• Base type string

• Type constraint (self in ['present', 'present-if-no-rfc2833', 'not-present'])

typedef perimeta::account::call_media_policy_media_bypass_policy_t

• Base type string

• Type constraint (self in ['allow', 'forbid', 'same-remote-ip-only'])

typedef perimeta::account::call_media_policy_media_capture_percentage_t

• Base type int

• Type constraint ((self >= 0) and (self <= 100))

typedef perimeta::account::call_media_policy_media_latching_t

• Base type string

• Type constraint (self in ['enabled', 'disabled', 'outbound-disabled'])

typedef perimeta::account::call_media_policy_media_timeout_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967))

typedef perimeta::account::call_media_policy_remove_csrc_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::account::call_media_policy_rtcp_multiplexing_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::account::call_media_policy_rtcp_suppression_t

• Base type string

• Type constraint (self in ['force-generate-rtcp', 'always-send-rtcp', 'enabled', 'disabled'])

typedef perimeta::account::call_media_policy_rtcp_xr_block_types_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::account::call_media_policy_secure_media_t

• Base type string

• Type constraint (self in ['allowed', 'required', 'unsignaled'])

typedef perimeta::account::call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t

• Base type string

• Type constraint (self in ['allowed', 'suppressed'])

typedef perimeta::account::call_media_policy_transcoding_trigger_t

• Base type string

• Type constraint (self in ['always', 'include-all-of', 'retry-on-4xx'])

typedef perimeta::account::traffic_group_call_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::account::traffic_group_call_limits_max_call_duration_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::account::traffic_group_call_limits_max_media_renegotiations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_call_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_call_media_policy_active_call_bypass_t

• Base type string

• Type constraint (self in ['allow', 'forbid'])

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_max_size_t

• Base type int

• Type constraint ((self >= 1) and (self <= 8000))

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_min_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_step_rate_t

• Base type int

• Type constraint ((self >= 1) and (self <= 100))

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_step_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_t

• Base type string

• Type constraint (self in ['off', 'fixed', 'adaptive'])

typedef perimeta::account::traffic_group_call_media_policy_bandwidth_policing_mode_t

• Base type string

• Type constraint (self in ['remove-streams', 'reject-calls', 'reduce-bandwidth'])

typedef perimeta::account::traffic_group_call_media_policy_comfort_noise_codec_t

• Base type string

• Type constraint (self in ['interwork', 'passthrough'])

typedef perimeta::account::traffic_group_call_media_policy_early_media_p_early_media_t

• Base type string

• Type constraint (self in ['passthrough', 'drop', 'calling', 'called', 'both'])

typedef perimeta::account::traffic_group_call_media_policy_early_media_timeout_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2000000))

typedef perimeta::account::traffic_group_call_media_policy_fax_transcoding_default_pcm_type_t

• Base type string

• Type constraint (self in ['pcmu', 'pcma'])

typedef perimeta::account::traffic_group_call_media_policy_fax_transcoding_generate_reinvite_t

• Base type string

• Type constraint (self in ['disabled', 'enabled', 'on-cng'])

typedef perimeta::account::traffic_group_call_media_policy_fax_transcoding_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4000))

typedef perimeta::account::traffic_group_call_media_policy_fax_transcoding_t

• Base type string

• Type constraint (self in ['disabled', 'pcm', 't38'])

typedef perimeta::account::traffic_group_call_media_policy_fax_transcoding_tone_detection_mode_t

• Base type string

• Type constraint (self in ['on-transcode', 'on-fax-mode'])

typedef perimeta::account::traffic_group_call_media_policy_force_ptime_t

• Base type string

• Type constraint (self in ['specify', 'dynamic'])

typedef perimeta::account::traffic_group_call_media_policy_force_ptime_value_t

• Base type int

• Type constraint ((self >= 10) and (self <= 200))

typedef perimeta::account::traffic_group_call_media_policy_hold_indicator_t

• Base type string

• Type constraint (self in ['hold-c0-a-line', 'hold-c0-inactive', 'hold-c0-sendonly', 'hold-c0', 'hold-sendonly', 'hold-inactive', 'hold-no-c0'])

typedef perimeta::account::traffic_group_call_media_policy_ice_lite_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::account::traffic_group_call_media_policy_inband_tone_interworking_t

• Base type string

• Type constraint (self in ['never', 'on-transcode', 'always'])

typedef perimeta::account::traffic_group_call_media_policy_inband_tones_t

• Base type string

• Type constraint (self in ['present', 'present-if-no-rfc2833', 'not-present'])

typedef perimeta::account::traffic_group_call_media_policy_media_bypass_policy_t

• Base type string

• Type constraint (self in ['allow', 'forbid', 'optimal-media-routing', 'same-remote-ip-only'])

typedef perimeta::account::traffic_group_call_media_policy_media_capture_percentage_t

• Base type int

• Type constraint ((self >= 0) and (self <= 100))

typedef perimeta::account::traffic_group_call_media_policy_media_latching_t

• Base type string

• Type constraint (self in ['enabled', 'disabled', 'outbound-disabled'])

typedef perimeta::account::traffic_group_call_media_policy_media_timeout_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967))

typedef perimeta::account::traffic_group_call_media_policy_remove_csrc_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::account::traffic_group_call_media_policy_rtcp_multiplexing_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::account::traffic_group_call_media_policy_rtcp_suppression_t

• Base type string

• Type constraint (self in ['force-generate-rtcp', 'always-send-rtcp', 'enabled', 'disabled'])

typedef perimeta::account::traffic_group_call_media_policy_rtcp_xr_block_types_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::account::traffic_group_call_media_policy_secure_media_t

• Base type string

• Type constraint (self in ['allowed', 'required', 'unsignaled'])

typedef perimeta::account::traffic_group_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t

• Base type string

• Type constraint (self in ['allowed', 'suppressed'])

typedef perimeta::account::traffic_group_call_media_policy_transcoding_trigger_t

• Base type string

• Type constraint (self in ['always', 'include-all-of', 'retry-on-4xx'])

typedef perimeta::account::traffic_group_traffic_group_limits_call_appearances_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_direction_t

• Base type string

• Type constraint (self in ['both-ways', 'as-source', 'as-destination'])

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::account::traffic_group_traffic_group_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_registrations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::account::traffic_group_traffic_group_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 22))

typedef perimeta::address_group::address_group_address_group_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::address_group::address_group_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_adjacency_limits_call_appearances_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_direction_t

• Base type string

• Type constraint (self in ['both-ways', 'as-source', 'as-destination'])

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::adjacency::sip_adjacency_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_registrations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_adjacency_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::adjacency::sip_adjacency_type_t

• Base type string

• Type constraint (self in ['none', 'preset-access', 'preset-core', 'preset-ibcf-ext-untrusted', 'preset-ibcf-external', 'preset-ibcf-internal', 'preset-p-cscf-access', 'preset-p-cscf-core', 'preset-p-cscf-access-ipsec', 'preset-peering', 'preset-standard-non-ims', 'preset-e-cscf-lrf', 'preset-ims-core', 'preset-ims-srvcc-msc', 'preset-eatf-core'])

typedef perimeta::adjacency::sip_call_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::adjacency::sip_call_limits_max_call_duration_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_call_limits_max_media_renegotiations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_call_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_call_media_policy_active_call_bypass_t

• Base type string

• Type constraint (self in ['allow', 'forbid'])

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_max_size_t

• Base type int

• Type constraint ((self >= 1) and (self <= 8000))

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_min_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_step_rate_t

• Base type int

• Type constraint ((self >= 1) and (self <= 100))

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_step_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_t

• Base type string

• Type constraint (self in ['off', 'fixed', 'adaptive'])

typedef perimeta::adjacency::sip_call_media_policy_bandwidth_policing_mode_t

• Base type string

• Type constraint (self in ['remove-streams', 'reject-calls', 'reduce-bandwidth'])

typedef perimeta::adjacency::sip_call_media_policy_comfort_noise_codec_t

• Base type string

• Type constraint (self in ['interwork', 'passthrough'])

typedef perimeta::adjacency::sip_call_media_policy_early_media_p_early_media_t

• Base type string

• Type constraint (self in ['passthrough', 'drop', 'calling', 'called', 'both'])

typedef perimeta::adjacency::sip_call_media_policy_early_media_timeout_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2000000))

typedef perimeta::adjacency::sip_call_media_policy_fax_transcoding_default_pcm_type_t

• Base type string

• Type constraint (self in ['pcmu', 'pcma'])

typedef perimeta::adjacency::sip_call_media_policy_fax_transcoding_generate_reinvite_t

• Base type string

• Type constraint (self in ['disabled', 'enabled', 'on-cng'])

typedef perimeta::adjacency::sip_call_media_policy_fax_transcoding_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4000))

typedef perimeta::adjacency::sip_call_media_policy_fax_transcoding_t

• Base type string

• Type constraint (self in ['disabled', 'pcm', 't38'])

typedef perimeta::adjacency::sip_call_media_policy_fax_transcoding_tone_detection_mode_t

• Base type string

• Type constraint (self in ['on-transcode', 'on-fax-mode'])

typedef perimeta::adjacency::sip_call_media_policy_force_ptime_t

• Base type string

• Type constraint (self in ['specify', 'dynamic'])

typedef perimeta::adjacency::sip_call_media_policy_force_ptime_value_t

• Base type int

• Type constraint ((self >= 10) and (self <= 200))

typedef perimeta::adjacency::sip_call_media_policy_hold_indicator_t

• Base type string

• Type constraint (self in ['hold-c0-a-line', 'hold-c0-inactive', 'hold-c0-sendonly', 'hold-c0', 'hold-sendonly', 'hold-inactive', 'hold-no-c0'])

typedef perimeta::adjacency::sip_call_media_policy_ice_lite_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_call_media_policy_inband_tone_interworking_t

• Base type string

• Type constraint (self in ['never', 'on-transcode', 'always'])

typedef perimeta::adjacency::sip_call_media_policy_inband_tones_t

• Base type string

• Type constraint (self in ['present', 'present-if-no-rfc2833', 'not-present'])

typedef perimeta::adjacency::sip_call_media_policy_media_address_type_t

• Base type string

• Type constraint (self in ['ipv4', 'ipv6', 'both'])

typedef perimeta::adjacency::sip_call_media_policy_media_bypass_policy_t

• Base type string

• Type constraint (self in ['allow', 'forbid', 'optimal-media-routing', 'same-remote-ip-only'])

typedef perimeta::adjacency::sip_call_media_policy_media_capture_percentage_t

• Base type int

• Type constraint ((self >= 0) and (self <= 100))

typedef perimeta::adjacency::sip_call_media_policy_media_latching_t

• Base type string

• Type constraint (self in ['enabled', 'disabled', 'outbound-disabled'])

typedef perimeta::adjacency::sip_call_media_policy_media_timeout_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967))

typedef perimeta::adjacency::sip_call_media_policy_remove_csrc_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_call_media_policy_rtcp_multiplexing_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_call_media_policy_rtcp_suppression_t

• Base type string

• Type constraint (self in ['force-generate-rtcp', 'always-send-rtcp', 'enabled', 'disabled'])

typedef perimeta::adjacency::sip_call_media_policy_rtcp_xr_block_types_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::adjacency::sip_call_media_policy_secure_media_t

• Base type string

• Type constraint (self in ['allowed', 'required', 'unsignaled'])

typedef perimeta::adjacency::sip_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t

• Base type string

• Type constraint (self in ['allowed', 'suppressed'])

typedef perimeta::adjacency::sip_call_media_policy_srtp_mki_t

• Base type string

• Type constraint (self in ['never-offer', 'always-offer'])

typedef perimeta::adjacency::sip_call_media_policy_transcoding_trigger_t

• Base type string

• Type constraint (self in ['always', 'include-all-of', 'retry-on-4xx'])

typedef perimeta::adjacency::sip_client_data_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::adjacency::sip_collect_statistics_t

• Base type string

• Type constraint (self in ['none', 'summary', 'detail'])

typedef perimeta::adjacency::sip_contact_header_username_t

• Base type string

• Type constraint (self in ['rewrite', 'passthrough'])

typedef perimeta::adjacency::sip_deactivation_mode_t

• Base type string

• Type constraint (self in ['quiesce', 'abort', 'normal'])

typedef perimeta::adjacency::sip_delegate_authentication_authentication_realm_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_delegate_authentication_hashed_password_t

• Base type string

• Type constraint ((std::length(self) >= 32) and (std::length(self) <= 32))

typedef perimeta::adjacency::sip_delegate_authentication_username_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::adjacency::sip_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_dns_source_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_dns_source_t

• Base type string

• Type constraint (self in ['inherit', 'management', 'service-address'])

typedef perimeta::adjacency::sip_dynamic_routing_domain_match_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_ecn_target_peer_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_ecn_target_port_t

• Base type string

• Type constraint (self in ['specify', 'use-default'])

typedef perimeta::adjacency::sip_ecn_target_port_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::adjacency::sip_ecn_target_t

• Base type string

• Type constraint (self in ['disabled', 'peer', 'peer-group'])

typedef perimeta::adjacency::sip_force_signaling_peer_t

• Base type string

• Type constraint (self in ['never', 'all-requests', 'initial-requests'])

typedef perimeta::adjacency::sip_interop_3xx_embedded_headers_t

• Base type string

• Type constraint (self in ['specify', 'none'])

typedef perimeta::adjacency::sip_interop_3xx_embedded_headers_value_t

• Base type string

• Type constraint ((std::length(self) >= 2) and (std::length(self) <= 512))

typedef perimeta::adjacency::sip_interop_active_unregister_t

• Base type string

• Type constraint (self in ['disabled', 'no-authorization-headers', 'add-x-header', 'repeat-credentials', 'add-all-headers'])

typedef perimeta::adjacency::sip_interop_call_handling_incomplete_information_t

• Base type string

• Type constraint (self in ['reject', 'passthrough'])

typedef perimeta::adjacency::sip_interop_call_handling_verification_failure_t

• Base type string

• Type constraint (self in ['reject', 'passthrough'])

typedef perimeta::adjacency::sip_interop_custom_data_key_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::adjacency::sip_interop_custom_data_t

• Base type string

• Type constraint (self in ['inherit', 'specify'])

typedef perimeta::adjacency::sip_interop_custom_data_value_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::adjacency::sip_interop_dialog_transparency_t

• Base type string

• Type constraint (self in ['rewrite', 'pass-through'])

typedef perimeta::adjacency::sip_interop_distribute_expiry_t

• Base type int

• Type constraint ((self >= 0) and (self <= 30))

typedef perimeta::adjacency::sip_interop_dtmf_force_passthrough_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_dtmf_preferred_method_t

• Base type string

• Type constraint (self in ['sip-info', 'sip-notify'])

typedef perimeta::adjacency::sip_interop_dtmf_sip_info_t

• Base type string

• Type constraint (self in ['not-supported', 'always-supported', 'auto-detect'])

typedef perimeta::adjacency::sip_interop_dtmf_sip_notify_t

• Base type string

• Type constraint (self in ['not-supported', 'auto-detect'])

typedef perimeta::adjacency::sip_interop_dynamic_ims_aka_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_dynamic_peer_routing_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_edit_profiles_inbound_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 1024))

typedef perimeta::adjacency::sip_interop_edit_profiles_outbound_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 1024))

typedef perimeta::adjacency::sip_interop_emergency_calling_elin_support_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_header_settings_contact_header_add_tls_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_header_settings_from_header_host_source_t

• Base type string

• Type constraint (self in ['local', 'peer', 'registrar'])

typedef perimeta::adjacency::sip_interop_header_settings_inbound_via_handling_t

• Base type string

• Type constraint (self in ['passthrough', 'strip'])

typedef perimeta::adjacency::sip_interop_header_settings_include_port_in_from_header_t

• Base type string

• Type constraint (self in ['include', 'exclude'])

typedef perimeta::adjacency::sip_interop_header_settings_outbound_via_handling_t

• Base type string

• Type constraint (self in ['passthrough', 'strip'])

typedef perimeta::adjacency::sip_interop_header_settings_p_asserted_id_t

• Base type string

• Type constraint (self in ['add', 'do-not-change'])

typedef perimeta::adjacency::sip_interop_header_settings_p_attestation_indicator_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::adjacency::sip_interop_header_settings_p_origination_id_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::adjacency::sip_interop_header_settings_reason_t

• Base type string

• Type constraint (self in ['do-not-add', 'from-verification'])

typedef perimeta::adjacency::sip_interop_header_settings_refer_to_uri_t

• Base type string

• Type constraint (self in ['use-address-of-record', 'use-contact-uri'])

typedef perimeta::adjacency::sip_interop_header_settings_respect_id_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::adjacency::sip_interop_header_settings_respect_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::adjacency::sip_interop_header_settings_respect_resource_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::adjacency::sip_interop_header_settings_rewrite_from_header_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_header_settings_rewrite_to_header_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_header_settings_suppress_expires_header_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_header_settings_verstat_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::adjacency::sip_interop_hunting_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_hunting_triggers_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_interop_message_signing_t

• Base type string

• Type constraint (self in ['primary-service', 'alternate-service', 'disabled'])

typedef perimeta::adjacency::sip_interop_message_verification_t

• Base type string

• Type constraint (self in ['primary-service', 'alternate-service', 'disabled'])

typedef perimeta::adjacency::sip_interop_ms_teams_version_header_t

• Base type string

• Type constraint (self in ['added', 'not-added'])

typedef perimeta::adjacency::sip_interop_options_ping_failure_threshold_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967294))

typedef perimeta::adjacency::sip_interop_options_ping_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_options_ping_lifetime_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_options_ping_max_forwards_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::adjacency::sip_interop_options_ping_mechanism_t

• Base type string

• Type constraint (self in ['continuous-poll', 'pause-during-traffic'])

typedef perimeta::adjacency::sip_interop_options_ping_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_interop_options_ping_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_interop_options_ping_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::adjacency::sip_interop_options_ping_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_other_sip_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_interop_other_sip_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_interop_other_sip_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::adjacency::sip_interop_p_asserted_id_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_interop_p_attestation_ind_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::adjacency::sip_interop_p_origination_id_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::adjacency::sip_interop_preconditions_t

• Base type string

• Type constraint (self in ['passthrough', 'originate', 'terminate'])

typedef perimeta::adjacency::sip_interop_preferred_transport_t

• Base type string

• Type constraint (self in ['no-preference', 'udp', 'tcp', 'sctp'])

typedef perimeta::adjacency::sip_interop_priority_statistics_groups_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_registration_fast_register_grace_timer_t

• Base type int

• Type constraint ((self >= 0) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_registration_fast_register_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_registration_fast_register_match_on_call_id_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_registration_fast_register_non_nat_endpoints_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_registration_fast_register_non_nat_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_registration_fast_register_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_interop_registration_fast_register_tcp_t

• Base type string

• Type constraint (self in ['unsupported', 'fully-supported', 'legacy-behavior'])

typedef perimeta::adjacency::sip_interop_registration_min_expiry_time_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_interop_reinvite_without_sdp_t

• Base type string

• Type constraint (self in ['passthrough', 'respond-locally'])

typedef perimeta::adjacency::sip_interop_respond_when_no_username_max_forwards_limit_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::adjacency::sip_interop_respond_when_no_username_t

• Base type string

• Type constraint (self in ['always', 'never', 'based-on-max-forwards'])

typedef perimeta::adjacency::sip_interop_respond_when_username_max_forwards_limit_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::adjacency::sip_interop_respond_when_username_t

• Base type string

• Type constraint (self in ['always', 'never', 'based-on-max-forwards'])

typedef perimeta::adjacency::sip_interop_retry_on_additional_sip_errors_t

• Base type string

• Type constraint (self in ['none', 'specify'])

typedef perimeta::adjacency::sip_interop_retry_on_additional_sip_errors_value_t

• Base type string

• Type constraint ((std::length(self) >= 3) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_interop_session_timer_min_session_expiry_t

• Base type int

• Type constraint ((self >= 2) and (self <= 3600))

typedef perimeta::adjacency::sip_interop_session_timer_min_session_expiry_units_t

• Base type string

• Type constraint (self in ['seconds', 'minutes'])

typedef perimeta::adjacency::sip_interop_session_timer_mode_t

• Base type string

• Type constraint (self in ['inherit', 'pass-through-session-timers', 'monitor-session-timers', 'block-session-refresh-requests', 'terminate-session-refresh-requests'])

typedef perimeta::adjacency::sip_interop_session_timer_preferred_refresh_originator_t

• Base type string

• Type constraint (self in ['none', 'sbc', 'peer'])

typedef perimeta::adjacency::sip_interop_session_timer_preferred_session_expiry_t

• Base type int

• Type constraint ((self >= 2) and (self <= 3600))

typedef perimeta::adjacency::sip_interop_session_timer_preferred_session_expiry_units_t

• Base type string

• Type constraint (self in ['seconds', 'minutes'])

typedef perimeta::adjacency::sip_interop_signing_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::adjacency::sip_interop_skip_peer_retry_on_503_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_interop_verification_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::adjacency::sip_interop_verstat_parameter_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::adjacency::sip_listen_for_transports_t

• Base type string

• Type constraint (self in ['default-for-adjacency-type', 'specify-transports'])

typedef perimeta::adjacency::sip_local_id_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_local_port_t

• Base type string

• Type constraint (self in ['default-port', 'single-port', 'port-range'])

typedef perimeta::adjacency::sip_local_single_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 16380))

typedef perimeta::adjacency::sip_mandate_transport_t

• Base type string

• Type constraint (self in ['allow-any-transport', 'udp', 'tcp', 'sctp'])

typedef perimeta::adjacency::sip_max_local_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 16380))

typedef perimeta::adjacency::sip_media_bypass_tags_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_min_local_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 16380))

typedef perimeta::adjacency::sip_msc_fallback_t

• Base type string

• Type constraint (self in ['none', 'to-realm-group', 'same-realm'])

typedef perimeta::adjacency::sip_msc_location_id_t

• Base type string

• Type constraint (self in ['specify', 'any', 'default'])

typedef perimeta::adjacency::sip_msc_location_id_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_nat_t

• Base type string

• Type constraint (self in ['disabled', 'force-on', 'autodetect'])

typedef perimeta::adjacency::sip_outbound_flood_rate_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::adjacency::sip_p_charging_vector_t

• Base type string

• Type constraint (self in ['passthrough', 'ensure-present', 'strip'])

typedef perimeta::adjacency::sip_privacy_t

• Base type string

• Type constraint (self in ['use-adjacency-preset', 'trusted', 'untrusted'])

typedef perimeta::adjacency::sip_realm_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_redirect_mode_t

• Base type string

• Type constraint (self in ['pass-through', 'recurse', 'recurse-and-reroute'])

typedef perimeta::adjacency::sip_registration_contact_match_t

• Base type string

• Type constraint (self in ['strict', 'permissive'])

typedef perimeta::adjacency::sip_registration_outgoing_timer_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::adjacency::sip_remote_address_range_prefix_length_t

• Base type int

• Type constraint ((self >= 0) and (self <= 128))

typedef perimeta::adjacency::sip_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::adjacency::sip_signaling_peer_port_t

• Base type int

• Type constraint ((self >= 0) and (self <= 65535))

typedef perimeta::adjacency::sip_signaling_peer_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::adjacency::sip_simple_routing_t

• Base type string

• Type constraint (self in ['disabled', 'adjacency'])

typedef perimeta::adjacency::sip_tls_certificate_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 16))

typedef perimeta::adjacency::sip_tls_fqdn_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 256))

typedef perimeta::adjacency::sip_tls_public_ca_store_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 16))

typedef perimeta::adjacency::sip_tls_t

• Base type string

• Type constraint (self in ['disabled', 'fqdn', 'subscriber-access'])

typedef perimeta::adjacency::sip_traffic_group_call_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::adjacency::sip_traffic_group_call_limits_max_call_duration_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::adjacency::sip_traffic_group_call_limits_max_media_renegotiations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_call_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_active_call_bypass_t

• Base type string

• Type constraint (self in ['allow', 'forbid'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_max_size_t

• Base type int

• Type constraint ((self >= 1) and (self <= 8000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_min_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_step_rate_t

• Base type int

• Type constraint ((self >= 1) and (self <= 100))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_step_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 8000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_t

• Base type string

• Type constraint (self in ['off', 'fixed', 'adaptive'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_bandwidth_policing_mode_t

• Base type string

• Type constraint (self in ['remove-streams', 'reject-calls', 'reduce-bandwidth'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_comfort_noise_codec_t

• Base type string

• Type constraint (self in ['interwork', 'passthrough'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_early_media_p_early_media_t

• Base type string

• Type constraint (self in ['passthrough', 'drop', 'calling', 'called', 'both'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_early_media_timeout_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2000000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_default_pcm_type_t

• Base type string

• Type constraint (self in ['pcmu', 'pcma'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_generate_reinvite_t

• Base type string

• Type constraint (self in ['disabled', 'enabled', 'on-cng'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_jitter_buffer_size_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4000))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_t

• Base type string

• Type constraint (self in ['disabled', 'pcm', 't38'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_tone_detection_mode_t

• Base type string

• Type constraint (self in ['on-transcode', 'on-fax-mode'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_force_ptime_t

• Base type string

• Type constraint (self in ['specify', 'dynamic'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_force_ptime_value_t

• Base type int

• Type constraint ((self >= 10) and (self <= 200))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_hold_indicator_t

• Base type string

• Type constraint (self in ['hold-c0-a-line', 'hold-c0-inactive', 'hold-c0-sendonly', 'hold-c0', 'hold-sendonly', 'hold-inactive', 'hold-no-c0'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_ice_lite_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_inband_tone_interworking_t

• Base type string

• Type constraint (self in ['never', 'on-transcode', 'always'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_inband_tones_t

• Base type string

• Type constraint (self in ['present', 'present-if-no-rfc2833', 'not-present'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_media_bypass_policy_t

• Base type string

• Type constraint (self in ['allow', 'forbid', 'optimal-media-routing', 'same-remote-ip-only'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_media_capture_percentage_t

• Base type int

• Type constraint ((self >= 0) and (self <= 100))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_media_latching_t

• Base type string

• Type constraint (self in ['enabled', 'disabled', 'outbound-disabled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_media_timeout_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_remove_csrc_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_multiplexing_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_suppression_t

• Base type string

• Type constraint (self in ['force-generate-rtcp', 'always-send-rtcp', 'enabled', 'disabled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_xr_block_types_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_secure_media_t

• Base type string

• Type constraint (self in ['allowed', 'required', 'unsignaled'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t

• Base type string

• Type constraint (self in ['allowed', 'suppressed'])

typedef perimeta::adjacency::sip_traffic_group_call_media_policy_transcoding_trigger_t

• Base type string

• Type constraint (self in ['always', 'include-all-of', 'retry-on-4xx'])

typedef perimeta::adjacency::sip_traffic_group_msc_location_id_precedence_t

• Base type string

• Type constraint (self in ['prefer-traffic-group', 'prefer-adjacency'])

typedef perimeta::adjacency::sip_traffic_group_msc_location_id_t

• Base type string

• Type constraint (self in ['inherit', 'any', 'default', 'specify'])

typedef perimeta::adjacency::sip_traffic_group_msc_location_id_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_privacy_t

• Base type string

• Type constraint (self in ['trusted', 'untrusted'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_appearances_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_direction_t

• Base type string

• Type constraint (self in ['both-ways', 'as-source', 'as-destination'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_max_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_media_streams_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_registrations_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_t

• Base type string

• Type constraint (self in ['unlimited', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_t

• Base type string

• Type constraint (self in ['inherit', 'manual'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::adjacency::sip_traffic_group_traffic_group_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 22))

typedef perimeta::adjacency::sip_trunk_group_source_trunk_group_context_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::adjacency::sip_trunk_group_source_trunk_group_id_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::adjacency::sip_trunk_group_t

• Base type string

• Type constraint (self in ['passthrough', 'strip-received', 'add-or-replace'])

typedef perimeta::ca_public_certificate_store::ca_certificate_ca_cert_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 16))

typedef perimeta::ca_public_certificate_store::ca_certificate_ca_certificate_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 10000))

typedef perimeta::ca_public_certificate_store::ca_public_certificate_store_ca_cert_store_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 16))

typedef perimeta::call_policy_set::call_policy_set_call_policy_set_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483647))

typedef perimeta::call_policy_set::call_policy_set_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::call_policy_set::routing_table_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 32))

typedef perimeta::call_policy_set::routing_table_entry_action_t

• Base type string

• Type constraint (self in ['complete', 'reject', 'next-table'])

typedef perimeta::call_policy_set::routing_table_entry_category_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 19))

typedef perimeta::call_policy_set::routing_table_entry_cic_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 3) and (std::length(self) <= 4))

typedef perimeta::call_policy_set::routing_table_entry_context_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_cost_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967294))

typedef perimeta::call_policy_set::routing_table_entry_desirable_threshold_t

• Base type int

• Type constraint ((self >= 0) and (self <= 86400))

typedef perimeta::call_policy_set::routing_table_entry_destination_number_manipulation_rule_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::call_policy_set::routing_table_entry_destination_tgid_manipulation_t

• Base type string

• Type constraint (self in ['none', 'strip', 'edit-context-and-tgid'])

typedef perimeta::call_policy_set::routing_table_entry_dynamic_peer_routing_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::call_policy_set::routing_table_entry_entry_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483647))

typedef perimeta::call_policy_set::routing_table_entry_match_account_t

• Base type string

• Type constraint (self in ['any', 'specify'])

typedef perimeta::call_policy_set::routing_table_entry_match_adjacency_t

• Base type string

• Type constraint (self in ['any', 'specify'])

typedef perimeta::call_policy_set::routing_table_entry_match_category_t

• Base type string

• Type constraint (self in ['any', 'custom-category', 'emergency', 'anonymous', 'redirected'])

typedef perimeta::call_policy_set::routing_table_entry_match_cic_t

• Base type string

• Type constraint (self in ['any', 'none', 'specify'])

typedef perimeta::call_policy_set::routing_table_entry_match_domain_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::call_policy_set::routing_table_entry_match_id_digits_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::call_policy_set::routing_table_entry_match_id_match_type_t

• Base type string

• Type constraint (self in ['regex', 'digits'])

typedef perimeta::call_policy_set::routing_table_entry_match_id_regex_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::call_policy_set::routing_table_entry_match_tgid_t

• Base type string

• Type constraint (self in ['any', 'none', 'context', 'context-and-tgid'])

typedef perimeta::call_policy_set::routing_table_entry_new_dest_context_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_new_dest_tgid_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_new_src_context_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_new_src_tgid_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_route_on_cost_t

• Base type string

• Type constraint (self in ['set-cost', 'dont-route'])

typedef perimeta::call_policy_set::routing_table_entry_source_number_manipulation_rule_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::call_policy_set::routing_table_entry_source_tgid_manipulation_t

• Base type string

• Type constraint (self in ['none', 'strip', 'edit-context-and-tgid'])

typedef perimeta::call_policy_set::routing_table_entry_tgid_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::call_policy_set::routing_table_entry_traffic_group_to_apply_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 22))

typedef perimeta::call_policy_set::routing_table_entry_unacceptable_threshold_t

• Base type int

• Type constraint ((self >= 0) and (self <= 86400))

typedef perimeta::call_policy_set::routing_table_entry_weight_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::call_policy_set::routing_table_metric_t

• Base type string

• Type constraint (self in ['acd', 'asr', 'r-factor'])

typedef perimeta::call_policy_set::routing_table_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::call_policy_set::routing_table_type_t

• Base type string

• Type constraint (self in ['carrier-id', 'category', 'destination-id', 'destination-domain', 'destination-tgid', 'least-cost', 'round-robin', 'source-id', 'source-adjacency', 'source-account', 'source-domain', 'source-tgid', 'time', 'qos-priority', 'qos-threshold', 'qos-weighted'])

typedef perimeta::called_number::called_number_call_setup_rate_max_burst_t

• Base type string

• Type constraint (self in ['manual', 'unlimited'])

typedef perimeta::called_number::called_number_call_setup_rate_max_burst_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::called_number::called_number_call_setup_rate_max_burst_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::called_number::called_number_call_setup_rate_max_sustain_t

• Base type string

• Type constraint (self in ['manual', 'unlimited'])

typedef perimeta::called_number::called_number_call_setup_rate_max_sustain_units_t

• Base type string

• Type constraint (self in ['per-second', 'per-minute'])

typedef perimeta::called_number::called_number_call_setup_rate_max_sustain_value_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967294))

typedef perimeta::called_number::called_number_called_number_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 80))

typedef perimeta::codec_list::codec_list_codec_list_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::codec_list::codec_list_default_priority_for_hd_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::codec_list::codec_list_default_priority_for_sd_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::codec_list::codec_list_default_transcoding_priority_for_hd_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::codec_list::codec_list_default_transcoding_priority_for_sd_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::codec_list::codec_list_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 127))

typedef perimeta::codec_list::codec_list_tc_cross_fidelity_penalty_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::codec_list::entry_codec_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::codec_list::entry_nominal_msrp_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::codec_list::entry_passthrough_priority_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::codec_list::entry_preferred_payload_type_t

• Base type int

• Type constraint ((self >= 96) and (self <= 127))

typedef perimeta::codec_list::entry_transcoding_fmtp_line_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 512))

typedef perimeta::codec_list::entry_transcoding_priority_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::custom_codec::dynamic_payload_type_channels_t

• Base type int

• Type constraint ((self >= 0) and (self <= 255))

typedef perimeta::custom_codec::dynamic_payload_type_clock_rate_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::custom_codec::dynamic_payload_type_codec_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 31))

typedef perimeta::custom_codec::dynamic_payload_type_codec_type_t

• Base type string

• Type constraint (self in ['fixed-rate', 'sampling-based', 'format-based', 'variable', 'redundancy', 'best-effort'])

typedef perimeta::custom_codec::dynamic_payload_type_fidelity_t

• Base type string

• Type constraint (self in ['sd', 'hd'])

typedef perimeta::custom_codec::dynamic_payload_type_max_frames_per_packet_t

• Base type int

• Type constraint ((self >= 0) and (self <= 65535))

typedef perimeta::custom_codec::dynamic_payload_type_media_type_t

• Base type string

• Type constraint (self in ['audio', 'video', 'application', 'data', 'control', 'image', 'omit', 'tel-event'])

typedef perimeta::custom_codec::dynamic_payload_type_packetization_time_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::custom_codec::dynamic_payload_type_required_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::custom_codec::dynamic_payload_type_sample_size_per_channel_t

• Base type int

• Type constraint ((self >= 1) and (self <= 255))

typedef perimeta::custom_codec::static_payload_type_channels_t

• Base type int

• Type constraint ((self >= 0) and (self <= 255))

typedef perimeta::custom_codec::static_payload_type_clock_rate_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::custom_codec::static_payload_type_codec_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 31))

typedef perimeta::custom_codec::static_payload_type_codec_type_t

• Base type string

• Type constraint (self in ['fixed-rate', 'sampling-based', 'format-based', 'variable', 'redundancy', 'best-effort'])

typedef perimeta::custom_codec::static_payload_type_fidelity_t

• Base type string

• Type constraint (self in ['sd', 'hd'])

typedef perimeta::custom_codec::static_payload_type_max_frames_per_packet_t

• Base type int

• Type constraint ((self >= 0) and (self <= 65535))

typedef perimeta::custom_codec::static_payload_type_media_type_t

• Base type string

• Type constraint (self in ['audio', 'video', 'application', 'data', 'control', 'image', 'omit', 'tel-event'])

typedef perimeta::custom_codec::static_payload_type_packetization_time_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::custom_codec::static_payload_type_payload_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 95))

typedef perimeta::custom_codec::static_payload_type_required_bandwidth_t

• Base type int

• Type constraint ((self >= 0) and (self <= 9223372036854775807))

typedef perimeta::custom_codec::static_payload_type_sample_size_per_channel_t

• Base type int

• Type constraint ((self >= 1) and (self <= 255))

typedef perimeta::delegate_subscriber::delegate_subscriber_delegate_subscriber_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 62))

typedef perimeta::delegate_subscriber::delegate_subscriber_duration_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::delegate_subscriber::delegate_subscriber_refresh_buffer_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::delegate_subscriber::delegate_subscriber_registrar_hostname_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::delegate_subscriber::delegate_subscriber_retry_count_t

• Base type int

• Type constraint ((self >= 0) and (self <= 255))

typedef perimeta::delegate_subscriber::delegate_subscriber_retry_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::delegate_subscriber::sip_contact_sip_contact_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 62))

typedef perimeta::diagnostics::diagnostics_statistics_collection_interval_t

• Base type int

• Type constraint ((self >= 0) and (self <= 3600))

typedef perimeta::diagnostics::diagnostics_statistics_collection_interval_units_t

• Base type string

• Type constraint (self in ['seconds', 'minutes'])

typedef perimeta::diagnostics::diagnostics_statistics_file_flip_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 24))

typedef perimeta::diagnostics::marker_adjacency_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 96))

typedef perimeta::diagnostics::marker_adjacency_sas_logging_level_t

• Base type string

• Type constraint (self in ['standard', 'detailed'])

typedef perimeta::diagnostics::marker_number_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 96))

typedef perimeta::diagnostics::marker_number_number_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::diagnostics::marker_number_sas_logging_level_t

• Base type string

• Type constraint (self in ['standard', 'detailed'])

typedef perimeta::diagnostics::marker_remote_ip_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 96))

typedef perimeta::diagnostics::marker_remote_ip_sas_logging_level_t

• Base type string

• Type constraint (self in ['standard', 'detailed'])

typedef perimeta::diagnostics::marker_remote_ip_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::diagnostics::marker_service_network_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 96))

typedef perimeta::diagnostics::marker_service_network_sas_logging_level_t

• Base type string

• Type constraint (self in ['standard', 'detailed'])

typedef perimeta::diagnostics::marker_service_network_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::diagnostics::marker_uri_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 96))

typedef perimeta::diagnostics::marker_uri_sas_logging_level_t

• Base type string

• Type constraint (self in ['standard', 'detailed'])

typedef perimeta::diagnostics::marker_uri_uri_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::diagnostics::service_assurance_sas_discovery_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::diagnostics::service_assurance_sas_source_instance_t

• Base type string

• Type constraint (self in ['instance-a', 'instance-b'])

typedef perimeta::diagnostics::upload_server_remote_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::diagnostics::upload_server_remote_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::diagnostics::upload_server_server_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::diagnostics::upload_server_ssh_key_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::diagnostics::upload_server_target_directory_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::diagnostics::upload_server_user_account_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::diagnostics::ves_event_reporting_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 40))

typedef perimeta::diagnostics::ves_event_reporting_heartbeat_interval_t

• Base type int

• Type constraint ((self >= 10) and (self <= 86400))

typedef perimeta::diagnostics::ves_event_reporting_password_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 32))

typedef perimeta::diagnostics::ves_event_reporting_port_t

• Base type string

• Type constraint (self in ['http', 'https', 'specify'])

typedef perimeta::diagnostics::ves_event_reporting_port_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::diagnostics::ves_event_reporting_url_prefix_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 32))

typedef perimeta::diagnostics::ves_event_reporting_url_topic_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 32))

typedef perimeta::diagnostics::ves_event_reporting_username_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::diagnostics::ves_event_reporting_vnf_measurement_interval_t

• Base type int

• Type constraint ((self >= 30) and (self <= 86400))

typedef perimeta::diagnostics::ves_event_reporting_vnf_sample_rate_t

• Base type int

• Type constraint ((self >= 0) and (self <= 1000000000))

typedef perimeta::inbound_tunnel::inbound_tunnel_encapsulation_t

• Base type string

• Type constraint (self in ['vxlan'])

typedef perimeta::inbound_tunnel::inbound_tunnel_local_address_type_t

• Base type string

• Type constraint (self in ['per-instance-address', 'service-address'])

typedef perimeta::inbound_tunnel::inbound_tunnel_per_instance_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::inbound_tunnel::inbound_tunnel_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::inbound_tunnel::inbound_tunnel_tunnel_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::inbound_tunnel::inbound_tunnel_vni_t

• Base type int

• Type constraint ((self >= 0) and (self <= 16777215))

typedef perimeta::tunnel::peer_peer_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 16383))

typedef perimeta::interop_defaults::interop_defaults_custom_data_key_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::interop_defaults::interop_defaults_custom_data_t

• Base type string

• Type constraint (self in ['none', 'specify'])

typedef perimeta::interop_defaults::interop_defaults_custom_data_value_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::interop_defaults::interop_defaults_dialog_transparency_t

• Base type string

• Type constraint (self in ['rewrite', 'pass-through'])

typedef perimeta::interop_defaults::interop_defaults_distribute_expiry_t

• Base type int

• Type constraint ((self >= 0) and (self <= 30))

typedef perimeta::interop_defaults::interop_defaults_header_settings_respect_id_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::interop_defaults::interop_defaults_priority_statistics_groups_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_defaults::interop_defaults_signing_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::interop_defaults::interop_defaults_verification_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::interop_profile::interop_profile_3xx_embedded_headers_t

• Base type string

• Type constraint (self in ['specify', 'none'])

typedef perimeta::interop_profile::interop_profile_3xx_embedded_headers_value_t

• Base type string

• Type constraint ((std::length(self) >= 2) and (std::length(self) <= 512))

typedef perimeta::interop_profile::interop_profile_active_unregister_t

• Base type string

• Type constraint (self in ['no-authorization-headers', 'add-x-header', 'repeat-credentials', 'add-all-headers'])

typedef perimeta::interop_profile::interop_profile_call_handling_incomplete_information_t

• Base type string

• Type constraint (self in ['reject', 'passthrough'])

typedef perimeta::interop_profile::interop_profile_call_handling_verification_failure_t

• Base type string

• Type constraint (self in ['reject', 'passthrough'])

typedef perimeta::interop_profile::interop_profile_custom_data_key_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::interop_profile::interop_profile_custom_data_t

• Base type string

• Type constraint (self in ['inherit', 'specify'])

typedef perimeta::interop_profile::interop_profile_custom_data_value_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::interop_profile::interop_profile_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_dialog_transparency_t

• Base type string

• Type constraint (self in ['rewrite', 'pass-through'])

typedef perimeta::interop_profile::interop_profile_distribute_expiry_t

• Base type int

• Type constraint ((self >= 0) and (self <= 30))

typedef perimeta::interop_profile::interop_profile_dtmf_force_passthrough_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_dtmf_preferred_method_t

• Base type string

• Type constraint (self in ['sip-info', 'sip-notify'])

typedef perimeta::interop_profile::interop_profile_dtmf_sip_info_t

• Base type string

• Type constraint (self in ['not-supported', 'always-supported', 'auto-detect'])

typedef perimeta::interop_profile::interop_profile_dtmf_sip_notify_t

• Base type string

• Type constraint (self in ['not-supported', 'auto-detect'])

typedef perimeta::interop_profile::interop_profile_dynamic_ims_aka_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_dynamic_peer_routing_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_edit_profiles_inbound_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 1024))

typedef perimeta::interop_profile::interop_profile_edit_profiles_outbound_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 1024))

typedef perimeta::interop_profile::interop_profile_emergency_calling_elin_support_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_header_settings_contact_header_add_tls_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_header_settings_from_header_host_source_t

• Base type string

• Type constraint (self in ['local', 'peer'])

typedef perimeta::interop_profile::interop_profile_header_settings_inbound_via_handling_t

• Base type string

• Type constraint (self in ['passthrough', 'strip'])

typedef perimeta::interop_profile::interop_profile_header_settings_include_port_in_from_header_t

• Base type string

• Type constraint (self in ['include', 'exclude'])

typedef perimeta::interop_profile::interop_profile_header_settings_outbound_via_handling_t

• Base type string

• Type constraint (self in ['passthrough', 'strip'])

typedef perimeta::interop_profile::interop_profile_header_settings_p_asserted_id_t

• Base type string

• Type constraint (self in ['add', 'do-not-change'])

typedef perimeta::interop_profile::interop_profile_header_settings_p_attestation_indicator_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::interop_profile::interop_profile_header_settings_p_origination_id_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::interop_profile::interop_profile_header_settings_reason_t

• Base type string

• Type constraint (self in ['do-not-add', 'from-verification'])

typedef perimeta::interop_profile::interop_profile_header_settings_refer_to_uri_t

• Base type string

• Type constraint (self in ['use-address-of-record', 'use-contact-uri'])

typedef perimeta::interop_profile::interop_profile_header_settings_respect_id_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::interop_profile::interop_profile_header_settings_respect_priority_t

• Base type string

• Type constraint (self in ['always', 'never'])

typedef perimeta::interop_profile::interop_profile_header_settings_respect_resource_priority_t

• Base type string

• Type constraint (self in ['core-only', 'always', 'never'])

typedef perimeta::interop_profile::interop_profile_header_settings_rewrite_from_header_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_header_settings_rewrite_to_header_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_header_settings_suppress_expires_header_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_header_settings_verstat_t

• Base type string

• Type constraint (self in ['add', 'do-not-add'])

typedef perimeta::interop_profile::interop_profile_hunting_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_hunting_triggers_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::interop_profile::interop_profile_message_signing_t

• Base type string

• Type constraint (self in ['primary-service', 'alternate-service', 'disabled'])

typedef perimeta::interop_profile::interop_profile_message_verification_t

• Base type string

• Type constraint (self in ['primary-service', 'alternate-service', 'disabled'])

typedef perimeta::interop_profile::interop_profile_ms_teams_version_header_t

• Base type string

• Type constraint (self in ['added', 'not-added'])

typedef perimeta::interop_profile::interop_profile_options_ping_failure_threshold_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967294))

typedef perimeta::interop_profile::interop_profile_options_ping_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_options_ping_lifetime_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_options_ping_max_forwards_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::interop_profile::interop_profile_options_ping_mechanism_t

• Base type string

• Type constraint (self in ['continuous-poll', 'pause-during-traffic'])

typedef perimeta::interop_profile::interop_profile_options_ping_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_options_ping_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_options_ping_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::interop_profile::interop_profile_options_ping_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_other_sip_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_other_sip_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_other_sip_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::interop_profile::interop_profile_p_asserted_id_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::interop_profile::interop_profile_p_attestation_ind_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::interop_profile::interop_profile_p_origination_id_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::interop_profile::interop_profile_preconditions_t

• Base type string

• Type constraint (self in ['passthrough', 'originate', 'terminate'])

typedef perimeta::interop_profile::interop_profile_preferred_transport_t

• Base type string

• Type constraint (self in ['no-preference', 'udp', 'tcp', 'sctp'])

typedef perimeta::interop_profile::interop_profile_priority_statistics_groups_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_registration_fast_register_grace_timer_t

• Base type int

• Type constraint ((self >= 0) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_registration_fast_register_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_registration_fast_register_match_on_call_id_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_registration_fast_register_non_nat_endpoints_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_registration_fast_register_non_nat_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_registration_fast_register_t

• Base type string

• Type constraint (self in ['disabled', 'enabled'])

typedef perimeta::interop_profile::interop_profile_registration_fast_register_tcp_t

• Base type string

• Type constraint (self in ['unsupported', 'fully-supported', 'legacy-behavior'])

typedef perimeta::interop_profile::interop_profile_registration_min_expiry_time_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::interop_profile::interop_profile_reinvite_without_sdp_t

• Base type string

• Type constraint (self in ['passthrough', 'respond-locally'])

typedef perimeta::interop_profile::interop_profile_respond_when_no_username_max_forwards_limit_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::interop_profile::interop_profile_respond_when_no_username_t

• Base type string

• Type constraint (self in ['always', 'never', 'based-on-max-forwards'])

typedef perimeta::interop_profile::interop_profile_respond_when_username_max_forwards_limit_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::interop_profile::interop_profile_respond_when_username_t

• Base type string

• Type constraint (self in ['always', 'never', 'based-on-max-forwards'])

typedef perimeta::interop_profile::interop_profile_retry_on_additional_sip_errors_t

• Base type string

• Type constraint (self in ['none', 'specify'])

typedef perimeta::interop_profile::interop_profile_retry_on_additional_sip_errors_value_t

• Base type string

• Type constraint ((std::length(self) >= 3) and (std::length(self) <= 64))

typedef perimeta::interop_profile::interop_profile_session_timer_min_session_expiry_t

• Base type int

• Type constraint ((self >= 2) and (self <= 3600))

typedef perimeta::interop_profile::interop_profile_session_timer_min_session_expiry_units_t

• Base type string

• Type constraint (self in ['seconds', 'minutes'])

typedef perimeta::interop_profile::interop_profile_session_timer_mode_t

• Base type string

• Type constraint (self in ['inherit', 'pass-through-session-timers', 'monitor-session-timers', 'block-session-refresh-requests', 'terminate-session-refresh-requests'])

typedef perimeta::interop_profile::interop_profile_session_timer_preferred_refresh_originator_t

• Base type string

• Type constraint (self in ['none', 'sbc', 'peer'])

typedef perimeta::interop_profile::interop_profile_session_timer_preferred_session_expiry_t

• Base type int

• Type constraint ((self >= 2) and (self <= 3600))

typedef perimeta::interop_profile::interop_profile_session_timer_preferred_session_expiry_units_t

• Base type string

• Type constraint (self in ['seconds', 'minutes'])

typedef perimeta::interop_profile::interop_profile_signing_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::interop_profile::interop_profile_sip_interop_profile_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::interop_profile::interop_profile_skip_peer_retry_on_503_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::interop_profile::interop_profile_verification_standard_t

• Base type string

• Type constraint (self in ['atis', 'french'])

typedef perimeta::interop_profile::interop_profile_verstat_parameter_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::ip_access_control::blocklist_application_per_address_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::blocklist_application_per_port_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::blocklist_application_per_port_specific_address_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::blocklist_application_service_network_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::blocklist_application_specific_address_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::blocklist_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::ip_access_control::trusted_sources_address_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::ip_access_control::trusted_sources_address_prioritization_t

• Base type string

• Type constraint (self in ['prioritized', 'unrestricted', 'unprioritized'])

typedef perimeta::ip_access_control::trusted_sources_address_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ip_access_control::trusted_sources_range_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::ip_access_control::trusted_sources_range_prioritization_t

• Base type string

• Type constraint (self in ['prioritized', 'unrestricted', 'unprioritized'])

typedef perimeta::ip_access_control::trusted_sources_range_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::ipsec_peer::crypto_algorithms_proposal_priority_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2000000000))

typedef perimeta::ipsec_peer::ipsec_peer_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::ipsec_peer::ipsec_peer_key_exchange_remote_port_t

• Base type string

• Type constraint (self in ['specify', 'default'])

typedef perimeta::ipsec_peer::ipsec_peer_key_exchange_remote_port_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::ipsec_peer::ipsec_peer_key_exchange_type_t

• Base type string

• Type constraint (self in ['ikev1', 'ikev2'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_t

• Base type string

• Type constraint (self in ['disabled', 'specify'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_units_t

• Base type string

• Type constraint (self in ['bytes', 'kbytes', 'mbytes', 'gbytes'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_t

• Base type string

• Type constraint (self in ['disabled', 'specify'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_units_t

• Base type string

• Type constraint (self in ['minutes', 'hours'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 1000000))

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_packets_limit_t

• Base type string

• Type constraint (self in ['specify', 'unlimited'])

typedef perimeta::ipsec_peer::ipsec_peer_key_lifetime_packets_limit_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 9223372036854775807))

typedef perimeta::ipsec_peer::ipsec_peer_liveness_check_attempts_t

• Base type int

• Type constraint ((self >= 1) and (self <= 20))

typedef perimeta::ipsec_peer::ipsec_peer_liveness_check_interval_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::ipsec_peer::ipsec_peer_local_identity_t

• Base type string

• Type constraint (self in ['specify', 'local-service-address'])

typedef perimeta::ipsec_peer::ipsec_peer_local_identity_value_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::ipsec_peer::ipsec_peer_local_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::ipsec_peer::ipsec_peer_peer_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 60))

typedef perimeta::ipsec_peer::ipsec_peer_pre_shared_key_type_t

• Base type string

• Type constraint (self in ['disabled', 'ascii', 'hex', 'base64'])

typedef perimeta::ipsec_peer::ipsec_peer_pre_shared_key_value_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 256))

typedef perimeta::ipsec_peer::ipsec_peer_refresh_after_t

• Base type string

• Type constraint (self in ['disabled', 'specify'])

typedef perimeta::ipsec_peer::ipsec_peer_refresh_after_units_t

• Base type string

• Type constraint (self in ['minutes', 'hours'])

typedef perimeta::ipsec_peer::ipsec_peer_refresh_after_value_t

• Base type int

• Type constraint ((self >= 1) and (self <= 1000000))

typedef perimeta::ipsec_peer::ipsec_peer_rekey_margin_randomize_t

• Base type int

• Type constraint ((self >= 0) and (self <= 100))

typedef perimeta::ipsec_peer::ipsec_peer_rekey_margin_t

• Base type int

• Type constraint ((self >= 0) and (self <= 50))

typedef perimeta::ipsec_peer::ipsec_peer_remote_identity_t

• Base type string

• Type constraint (self in ['specify', 'remote-outer-address'])

typedef perimeta::ipsec_peer::ipsec_peer_remote_identity_value_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::ipsec_peer::ipsec_peer_use_ikev1_fragmentation_mode_t

• Base type string

• Type constraint (self in ['disabled', 'offer', 'force'])

typedef perimeta::ipsec_peer::remote_peer_inner_ip_address_range_prefix_length_t

• Base type int

• Type constraint ((self >= 0) and (self <= 128))

typedef perimeta::media_address::ip_port_range_class_of_service_t

• Base type string

• Type constraint (self in ['any', 'voice', 'video'])

typedef perimeta::media_address::ip_port_range_max_port_t

• Base type int

• Type constraint ((self >= 16384) and (self <= 65535))

typedef perimeta::media_address::ip_port_range_min_port_t

• Base type int

• Type constraint ((self >= 16384) and (self <= 65535))

typedef perimeta::media_address::ip_realm_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::media_address::ip_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::media_address::pool_port_range_class_of_service_t

• Base type string

• Type constraint (self in ['any', 'voice', 'video'])

typedef perimeta::media_address::pool_port_range_max_port_t

• Base type int

• Type constraint ((self >= 16384) and (self <= 65535))

typedef perimeta::media_address::pool_port_range_min_port_t

• Base type int

• Type constraint ((self >= 16384) and (self <= 65535))

typedef perimeta::media_address::pool_realm_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 255))

typedef perimeta::media_address::pool_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::media_realm_group::media_realm_group_media_realm_group_t

• Base type string

• Type constraint (self in ['fallback-group'])

typedef perimeta::peer_group_sip::peer_group_sip_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::peer_group_sip::peer_group_sip_dns_peer_address_type_t

• Base type string

• Type constraint (self in ['ipv4', 'ipv6'])

typedef perimeta::peer_group_sip::peer_group_sip_dns_peer_port_source_t

• Base type string

• Type constraint (self in ['from-dns-lookup', 'fixed-port'])

typedef perimeta::peer_group_sip::peer_group_sip_dns_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::peer_group_sip::peer_group_sip_failure_threshold_t

• Base type int

• Type constraint ((self >= 1) and (self <= 4294967295))

typedef perimeta::peer_group_sip::peer_group_sip_interval_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::peer_group_sip::peer_group_sip_lifetime_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483))

typedef perimeta::peer_group_sip::peer_group_sip_max_forwards_t

• Base type int

• Type constraint ((self >= 0) and (self <= 70))

typedef perimeta::peer_group_sip::peer_group_sip_options_ping_mechanism_t

• Base type string

• Type constraint (self in ['continuous-poll', 'pause-during-traffic', 'traffic-only'])

typedef perimeta::peer_group_sip::peer_group_sip_options_ping_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::peer_group_sip::peer_group_sip_options_ping_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::peer_group_sip::peer_group_sip_options_ping_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::peer_group_sip::peer_group_sip_options_ping_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::peer_group_sip::peer_group_sip_other_sip_response_failure_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::peer_group_sip::peer_group_sip_other_sip_response_success_codes_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::peer_group_sip::peer_group_sip_other_sip_response_t

• Base type string

• Type constraint (self in ['define-success-response-codes', 'define-failure-response-codes'])

typedef perimeta::peer_group_sip::peer_group_sip_peer_group_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::peer_group_sip::peer_group_sip_peer_hostname_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 255))

typedef perimeta::peer_group_sip::peer_group_sip_retry_delay_t

• Base type int

• Type constraint ((self >= 1) and (self <= 1800))

typedef perimeta::peer_group_sip::peer_group_sip_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::peer_group_sip::peer_peer_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::peer_group_sip::peer_port_t

• Base type int

• Type constraint ((self >= 1) and (self <= 65535))

typedef perimeta::priority_call_media_limit::priority_call_media_limit_maximum_call_priority_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_call_media_limit::priority_call_media_limit_occupancy_limit_t

• Base type int

• Type constraint ((self >= 1) and (self <= 100))

typedef perimeta::priority_category::priority_category_call_limit_bypass_t

• Base type string

• Type constraint (self in ['enabled', 'disabled'])

typedef perimeta::priority_category::priority_category_sip_priority_category_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::priority_category::resource_priority_header_match_priority_level_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::resource_priority_header_match_priority_statistics_group_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::resource_priority_header_match_remove_resource_priority_header_t

• Base type string

• Type constraint (self in ['disabled', 'header-not-respected', 'always'])

typedef perimeta::priority_category::resource_priority_header_match_resource_priority_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::priority_category::rn_pattern_match_match_rn_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::priority_category::rn_pattern_match_priority_level_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::rn_pattern_match_priority_statistics_group_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::rn_pattern_match_resource_priority_header_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::priority_category::uri_pattern_match_match_id_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 128))

typedef perimeta::priority_category::uri_pattern_match_priority_level_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::uri_pattern_match_priority_statistics_group_t

• Base type int

• Type constraint ((self >= 1) and (self <= 15))

typedef perimeta::priority_category::uri_pattern_match_resource_priority_header_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::push_notification_service::push_notification_service_application_id_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::push_notification_service::push_notification_service_certificate_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 4000))

typedef perimeta::push_notification_service::push_notification_service_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::push_notification_service::push_notification_service_private_key_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 4000))

typedef perimeta::push_notification_service::push_notification_service_service_network_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::push_notification_service::push_notification_service_service_type_t

• Base type string

• Type constraint (self in ['apns'])

typedef perimeta::qos::msrp_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::qos::sig_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::qos::video_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::qos::voice_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::routing::routing_max_routing_attempts_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4294967295))

typedef perimeta::service_interface::ipv4_gateway_static_mac_address_t

• Base type string

• Type constraint (self in ['specify', 'use-network-determined-mac-address'])

typedef perimeta::service_interface::ipv4_gateway_static_mac_address_value_t

• Base type string

• Type constraint ((std::length(self) >= 17) and (std::length(self) <= 17))

typedef perimeta::service_interface::ipv4_local_ip_address_local_ip_address_usage_t

• Base type string

• Type constraint (self in ['normal', 'off-lan'])

typedef perimeta::service_interface::ipv4_local_ip_address_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::service_interface::ipv4_per_instance_address_per_instance_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::service_interface::ipv4_probes_source_style_t

• Base type string

• Type constraint (self in ['specific-source-address', 'all-zero', 'subnet-all-zero'])

typedef perimeta::service_interface::ipv4_subnet_prefix_length_t

• Base type int

• Type constraint ((self >= 1) and (self <= 32))

typedef perimeta::service_interface::ipv6_gateway_static_mac_address_t

• Base type string

• Type constraint (self in ['specify', 'use-network-determined-mac-address'])

typedef perimeta::service_interface::ipv6_gateway_static_mac_address_value_t

• Base type string

• Type constraint ((std::length(self) >= 17) and (std::length(self) <= 17))

typedef perimeta::service_interface::ipv6_local_ip_address_local_ip_address_usage_t

• Base type string

• Type constraint (self in ['normal', 'off-lan'])

typedef perimeta::service_interface::ipv6_local_ip_address_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::service_interface::ipv6_probes_source_style_t

• Base type string

• Type constraint (self in ['specific-source-address', 'all-zero', 'subnet-all-zero'])

typedef perimeta::service_interface::ipv6_subnet_prefix_length_t

• Base type int

• Type constraint ((self >= 1) and (self <= 128))

typedef perimeta::service_interface::service_interface_criticality_t

• Base type int

• Type constraint ((self >= 0) and (self <= 1000))

typedef perimeta::service_interface::service_interface_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::service_interface::service_interface_dns_dscp_settings_t

• Base type int

• Type constraint ((self >= 0) and (self <= 63))

typedef perimeta::service_interface::service_interface_dns_selection_mode_t

• Base type string

• Type constraint (self in ['hunt', 'round-robin'])

typedef perimeta::service_interface::service_interface_dns_servers_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 512))

typedef perimeta::service_interface::service_interface_dns_source_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::service_interface::service_interface_dns_source_t

• Base type string

• Type constraint (self in ['legacy', 'management', 'service-address'])

typedef perimeta::service_interface::service_interface_mtu_t

• Base type string

• Type constraint (self in ['specify', 'inherit-from-port-group'])

typedef perimeta::service_interface::service_interface_mtu_value_t

• Base type int

• Type constraint ((self >= 1280) and (self <= 1500))

typedef perimeta::service_interface::service_interface_network_security_t

• Base type string

• Type constraint (self in ['trusted', 'untrusted', 'untrusted-priority', 'restricted'])

typedef perimeta::service_interface::service_interface_port_group_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::service_interface::service_interface_probes_failure_threshold_t

• Base type int

• Type constraint ((self >= 1) and (self <= 255))

typedef perimeta::service_interface::service_interface_probes_interval_t

• Base type int

• Type constraint ((self >= 20) and (self <= 1000))

typedef perimeta::service_interface::service_interface_probes_success_threshold_t

• Base type int

• Type constraint ((self >= 1) and (self <= 255))

typedef perimeta::service_interface::service_interface_probes_type_t

• Base type string

• Type constraint (self in ['none', 'ipv4', 'ipv6'])

typedef perimeta::service_interface::service_interface_service_interface_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::service_interface::service_interface_service_network_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4095))

typedef perimeta::service_interface::service_interface_vlan_id_t

• Base type int

• Type constraint ((self >= 0) and (self <= 4094))

typedef perimeta::signaling::signaling_sip_3xx_embedded_header_pass_mode_t

• Base type string

• Type constraint (self in ['add', 'replace'])

typedef perimeta::sip_generic_stream_list::sip_generic_stream_list_sip_generic_stream_list_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::body_manipulation_profile_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::body_manipulation_profile_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::body_manipulation_profile_rule_action_t

• Base type string

• Type constraint (self in ['pass', 'strip-or-reject', 'strip', 'reject'])

typedef perimeta::sip_message_manipulation::body_manipulation_profile_rule_content_type_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_not_found_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_not_found_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_void_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_void_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_carrier_id_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_carrier_id_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_destination_id_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_destination_id_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_account_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_account_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_adjacency_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_adjacency_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_id_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_id_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_subscriber_category_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_subscriber_category_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_no_calling_number_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_no_calling_number_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_max_routing_routes_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_max_routing_routes_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_carrier_id_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_carrier_id_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_category_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_category_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_address_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_address_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_domain_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_domain_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_tgid_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_tgid_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_account_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_account_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_address_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_address_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_adjacency_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_adjacency_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_domain_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_domain_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_tgid_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_tgid_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_least_cost_rejection_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_least_cost_rejection_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_round_robin_rejection_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_round_robin_rejection_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_time_table_rejection_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_time_table_rejection_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_route_unavailable_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_route_unavailable_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_msrp_not_allowed_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_msrp_not_allowed_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_msrps_not_allowed_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_msrps_not_allowed_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_no_acceptable_codec_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_no_acceptable_codec_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_general_error_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_general_error_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_calling_number_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_calling_number_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_destination_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_destination_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_other_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_other_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_per_call_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_per_call_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_IP_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_IP_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_scope_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_scope_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_override_too_many_media_streams_code_t

• Base type int

• Type constraint ((self >= 400) and (self <= 699))

typedef perimeta::sip_message_manipulation::error_profile_override_too_many_media_streams_reason_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::error_profile_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_allowlist_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::header_allowlist_header_allowlist_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_allowlist_header_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_header_profile_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_action_t

• Base type string

• Type constraint (self in ['pass', 'strip-header', 'terminate-request', 'drop-provisional-response', 'drop-request', 'add-first-header', 'add-header', 'replace-header-value', 'replace-header-name', 'add-category', 'apply-traffic-group', 'modify-sip-uri-user', 'modify-sip-uri-host', 'modify-sip-uri-port', 'modify-tel-uri', 'modify-entire-uri', 'map-code'])

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_advanced_match_condition_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_category_to_add_t

• Base type string

• Type constraint (self in ['suppress-rx', 'emergency', 'anonymous', 'recorded', 'custom-category'])

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_custom_category_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 19))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 512))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_map_response_code_t

• Base type int

• Type constraint ((self >= 101) and (self <= 699))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_header_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_header_value_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_host_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_port_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_user_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_tel_uri_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_uri_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_rule_index_t

• Base type int

• Type constraint ((self >= 0) and (self <= 99))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_sip_header_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_termination_response_code_t

• Base type int

• Type constraint ((self >= 200) and (self <= 699))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_traffic_group_to_apply_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 22))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 512))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_index_t

• Base type int

• Type constraint ((self >= 0) and (self <= 99))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 512))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_index_t

• Base type int

• Type constraint ((self >= 0) and (self <= 99))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 1024))

typedef perimeta::sip_message_manipulation::lua_config_set_lua_config_set_t

• Base type int

• Type constraint ((self >= 1) and (self <= 2147483647))

typedef perimeta::sip_message_manipulation::lua_config_set_lua_profile_content_type_header_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::lua_config_set_lua_profile_content_type_t

• Base type string

• Type constraint (self in ['sdp', 'any', 'specify'])

typedef perimeta::sip_message_manipulation::lua_config_set_lua_profile_lua_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::lua_config_set_lua_profile_profile_code_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 10000))

typedef perimeta::sip_message_manipulation::method_manipulation_profile_description_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_action_t

• Base type string

• Type constraint (self in ['pass-message', 'drop-message'])

typedef perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_sip_method_to_match_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 32))

typedef perimeta::sip_message_manipulation::method_manipulation_profile_method_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::parameter_profile_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_message_manipulation::replacement_profile_profile_name_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 30))

typedef perimeta::sip_signing_service::sip_signing_service_ca_certificate_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 16))

typedef perimeta::sip_signing_service::sip_signing_service_remote_url_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_signing_service::sip_signing_service_secondary_remote_url_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_signing_service::sip_signing_service_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_signing_service::sip_signing_service_sip_signing_service_t

• Base type string

• Type constraint (self in ['primary', 'alternate'])

typedef perimeta::sip_signing_service::sip_signing_service_timeout_t

• Base type int

• Type constraint ((self >= 50) and (self <= 2147483))

typedef perimeta::sip_verification_service::sip_verification_service_ca_certificate_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 16))

typedef perimeta::sip_verification_service::sip_verification_service_remote_url_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_verification_service::sip_verification_service_secondary_remote_url_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 256))

typedef perimeta::sip_verification_service::sip_verification_service_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::sip_verification_service::sip_verification_service_sip_verification_service_t

• Base type string

• Type constraint (self in ['primary', 'alternate'])

typedef perimeta::sip_verification_service::sip_verification_service_timeout_t

• Base type int

• Type constraint ((self >= 50) and (self <= 2147483))

typedef perimeta::tls_ciphers::tls_ciphers_management_https_server_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::tls_ciphers::tls_ciphers_service_traffic_client_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::tls_ciphers::tls_ciphers_service_traffic_server_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 2048))

typedef perimeta::tls_min_versions::tls_min_versions_management_https_server_t

• Base type string

• Type constraint (self in ['v1-0', 'v1-1', 'v1-2', 'v1-3'])

typedef perimeta::tls_min_versions::tls_min_versions_service_traffic_t

• Base type string

• Type constraint (self in ['v1-0', 'v1-1', 'v1-2', 'v1-3'])

typedef perimeta::tls_security_level::tls_security_level_service_traffic_t

• Base type string

• Type constraint (self in ['1', '2'])

typedef perimeta::tunnel::tunnel_encapsulation_t

• Base type string

• Type constraint (self in ['vxlan'])

typedef perimeta::tunnel::tunnel_local_address_type_t

• Base type string

• Type constraint (self in ['per-instance-address', 'service-address'])

typedef perimeta::tunnel::tunnel_per_instance_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::tunnel::tunnel_service_address_t

• Base type string

• Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef perimeta::tunnel::tunnel_tunnel_name_t

• Base type string

• Type constraint ((std::length(self) >= 0) and (std::length(self) <= 64))

typedef perimeta::tunnel::tunnel_vni_t

• Base type int

• Type constraint ((self >= 0) and (self <= 16777215))

Entities

entity perimeta::PerimetaApiObject

Parents: std::Entity

A resource on the perimeta API, not necessarily managed by inmanta. Children for managed resources should additionally extend std::Resource.

attribute string _uri

attribute dict _config

relation perimeta::PerimetaDevice device [1]

The following implementations are defined for this entity:

• perimeta::unmanaged

entity perimeta::PerimetaCredentials

Parents: perimeta::PerimetaCredentialsABC

API credentials for a Perimeta device.

relation perimeta::PerimetaDevice device [1]

other end: perimeta::PerimetaDevice.credentials [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity perimeta::PerimetaCredentialsABC

Parents: std::Dataclass

Base entity that represents the credentials attribute that may be serialized. This mirrors a Dataclass in the python domain.

attribute string client_certificate_path

attribute string private_key_path

The following implements statements select implementations for this entity:

• std::none constraint true

entity perimeta::PerimetaDevice

Parents: std::Entity

A perimeta device with associated API specifications.

attribute std::ipv_any_address address

The ip address where the api of the device can be reached.

attribute int port=443

The port on which the api is listening

attribute string api_version

The version of the api we are configuring resources onto.

attribute string agent_name

An optional name to use for the agent, default to the ip address.

attribute bool verify=true

Whether we should verify the ssl certificates served by the api.

relation perimeta::PerimetaCredentials credentials [1]

other end: perimeta::PerimetaCredentials.device [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity perimeta::account::Account

Parents: perimeta::account::AccountIdentity, std::PurgeableResource

Inmanta resource to manage a /account Perimeta API resource.

Configuration mode for an account on the Session Controller. An account allows related adjacencies to be grouped together so that the same capacity control limits can be applied to all of them. Typically, an account might represent a particular customer and all the adjacencies that belong to an account might be used for that customer. The capacity control limits must be configured using a child account-limits Resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::account_config

• perimeta::account::account_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::account_config, perimeta::account::account_cross_device_relations constraint true

entity perimeta::account::AccountIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account Perimeta API resource. Abstract base entity. For concrete usage, see children Account and AccountUnmanaged.

Configuration mode for an account on the Session Controller. An account allows related adjacencies to be grouped together so that the same capacity control limits can be applied to all of them. Typically, an account might represent a particular customer and all the adjacencies that belong to an account might be used for that customer. The capacity control limits must be configured using a child account-limits Resource.

attribute perimeta::account::account_account_t account

Name of the account

relation perimeta::account::TrafficGroupIdentity traffic_group [0:*]

other end: perimeta::account::TrafficGroupIdentity.account [1]

relation perimeta::account::CallMediaPolicyIdentity call_media_policy [0:1]

other end: perimeta::account::CallMediaPolicyIdentity.account [1]

relation perimeta::account::AccountLimitsIdentity account_limits [0:*]

other end: perimeta::account::AccountLimitsIdentity.account [1]

relation perimeta::account::CallLimitsIdentity call_limits [0:1]

other end: perimeta::account::CallLimitsIdentity.account [1]

The following implementations are defined for this entity:

• perimeta::account::account_uri

The following implements statements select implementations for this entity:

• perimeta::account::account_uri constraint true

entity perimeta::account::AccountLimits

Parents: perimeta::account::AccountLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /account/account-limits Perimeta API resource.

Configuration mode for capacity control limits for an account. Capacity control allows you to limit the number of calls and signaling messages passing through each adjacency in an account. If a call or signaling message would cause a configured capacity control limit to be breached, the Session Controller either rejects the call or signaling message, or attempts to reduce the bandwidth required.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::account_limits_call_appearances_t? call_appearances=null

Specifies the maximum number of concurrent calls permitted for this account. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute bool? call_appearances_use_default=null

Specifies the maximum number of concurrent calls permitted for this account. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute perimeta::account::account_limits_registrations_t? registrations=null

Specifies the maximum rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature, which are not passed on to the registrar. It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute bool? registrations_use_default=null

Specifies the maximum rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature, which are not passed on to the registrar. It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::account::account_limits_media_streams_t? media_streams=null

Sets a maximum number of concurrent media streams for this account.

attribute bool? media_streams_use_default=null

Sets a maximum number of concurrent media streams for this account.

attribute perimeta::account::account_limits_call_setup_rate_max_sustain_t? call_setup_rate_max_sustain=null

Specifies whether there is a maximum limit on the sustained rate at which call setup messages involving this account can be processed.

attribute perimeta::account::account_limits_call_setup_rate_max_sustain_value_t? call_setup_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-sustain-units Property.

attribute perimeta::account::account_limits_call_setup_rate_max_sustain_units_t? call_setup_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::account_limits_call_setup_rate_max_burst_t? call_setup_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this account.

attribute bool? call_setup_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this account.

attribute perimeta::account::account_limits_call_setup_rate_max_burst_value_t? call_setup_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-burst-units Property.

attribute perimeta::account::account_limits_call_setup_rate_max_burst_units_t? call_setup_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::account_limits_in_call_message_rate_max_sustain_t? in_call_message_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which in-call signaling messages can be sent to or from this account.

attribute perimeta::account::account_limits_in_call_message_rate_max_sustain_value_t? in_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-sustain-units Property.

attribute perimeta::account::account_limits_in_call_message_rate_max_sustain_units_t? in_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::account_limits_in_call_message_rate_max_burst_t? in_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this account.

attribute bool? in_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this account.

attribute perimeta::account::account_limits_in_call_message_rate_max_burst_value_t? in_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-burst-units Property.

attribute perimeta::account::account_limits_in_call_message_rate_max_burst_units_t? in_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_sustain_t? out_of_call_message_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which out-of-call signaling messages can be sent to or from this account.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_sustain_value_t? out_of_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-sustain-units Property.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_sustain_units_t? out_of_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_burst_t? out_of_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which out-of-call signaling messages can be sent to or from this account.

attribute bool? out_of_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which out-of-call signaling messages can be sent to or from this account.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_burst_value_t? out_of_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-burst-units Property.

attribute perimeta::account::account_limits_out_of_call_message_rate_max_burst_units_t? out_of_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::account_limits_regs_rate_max_sustain_t? regs_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::account::account_limits_regs_rate_max_sustain_value_t? regs_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-sustain-units Property.

attribute perimeta::account::account_limits_regs_rate_max_sustain_units_t? regs_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::account_limits_regs_rate_max_burst_t? regs_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute bool? regs_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::account::account_limits_regs_rate_max_burst_value_t? regs_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-burst-units Property.

attribute perimeta::account::account_limits_regs_rate_max_burst_units_t? regs_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::account_limits_max_bandwidth_t? max_bandwidth=null

Sets a maximum for the amount of bandwidth used by this account at any one time.

attribute bool? max_bandwidth_use_default=null

Sets a maximum for the amount of bandwidth used by this account at any one time.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::account_limits_config

• perimeta::account::account_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::account_limits_config, perimeta::account::account_limits_cross_device_relations constraint true

entity perimeta::account::AccountLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/account-limits Perimeta API resource. Abstract base entity. For concrete usage, see children AccountLimits and AccountLimitsUnmanaged.

Configuration mode for capacity control limits for an account. Capacity control allows you to limit the number of calls and signaling messages passing through each adjacency in an account. If a call or signaling message would cause a configured capacity control limit to be breached, the Session Controller either rejects the call or signaling message, or attempts to reduce the bandwidth required.

attribute perimeta::account::account_limits_direction_t direction

Specifies the direction in which capacity control limits must be applied.

relation perimeta::account::AccountIdentity account [1]

other end: perimeta::account::AccountIdentity.account_limits [0:*]

The following implementations are defined for this entity:

• perimeta::account::account_limits_uri

The following implements statements select implementations for this entity:

• perimeta::account::account_limits_uri constraint true

entity perimeta::account::AccountLimitsUnmanaged

Parents: perimeta::account::AccountLimitsIdentity

Unmanaged reference to a /account/account-limits Perimeta API resource.

Configuration mode for capacity control limits for an account. Capacity control allows you to limit the number of calls and signaling messages passing through each adjacency in an account. If a call or signaling message would cause a configured capacity control limit to be breached, the Session Controller either rejects the call or signaling message, or attempts to reduce the bandwidth required.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::AccountUnmanaged

Parents: perimeta::account::AccountIdentity

Unmanaged reference to a /account Perimeta API resource.

Configuration mode for an account on the Session Controller. An account allows related adjacencies to be grouped together so that the same capacity control limits can be applied to all of them. Typically, an account might represent a particular customer and all the adjacencies that belong to an account might be used for that customer. The capacity control limits must be configured using a child account-limits Resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::CallLimits

Parents: perimeta::account::CallLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /account/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this account. For more information, see Capacity control in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CapacityControl.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::call_limits_max_media_renegotiations_t? max_media_renegotiations=null

Sets a maximum number of media renegotiations per call for this account.

attribute bool? max_media_renegotiations_use_default=null

Sets a maximum number of media renegotiations per call for this account.

attribute perimeta::account::call_limits_media_streams_t? media_streams=null

Sets a maximum number of media streams per call for this account.

attribute bool? media_streams_use_default=null

Sets a maximum number of media streams per call for this account.

attribute perimeta::account::call_limits_max_call_duration_t? max_call_duration=null

Set the maximum duration in seconds for a call on this account.

attribute bool? max_call_duration_use_default=null

Set the maximum duration in seconds for a call on this account.

attribute perimeta::account::call_limits_max_bandwidth_t? max_bandwidth=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this account. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? max_bandwidth_use_default=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this account. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::call_limits_config

• perimeta::account::call_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::call_limits_config, perimeta::account::call_limits_cross_device_relations constraint true

entity perimeta::account::CallLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/call-limits Perimeta API resource. Abstract base entity. For concrete usage, see children CallLimits and CallLimitsUnmanaged.

Configuration mode for capacity control limits applying to individual calls involving this account. For more information, see Capacity control in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CapacityControl.html).

relation perimeta::account::AccountIdentity account [1]

other end: perimeta::account::AccountIdentity.call_limits [0:1]

The following implementations are defined for this entity:

• perimeta::account::call_limits_uri

The following implements statements select implementations for this entity:

• perimeta::account::call_limits_uri constraint true

entity perimeta::account::CallLimitsUnmanaged

Parents: perimeta::account::CallLimitsIdentity

Unmanaged reference to a /account/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this account. For more information, see Capacity control in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CapacityControl.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::CallMediaPolicy

Parents: perimeta::account::CallMediaPolicyIdentity, std::PurgeableResource

Inmanta resource to manage a /account/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls through this account. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). Account settings will only apply when no specific setting is configured for a particular adjacency.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::call_media_policy_ice_lite_t? ice_lite=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this account. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute bool? ice_lite_use_default=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this account. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute perimeta::account::call_media_policy_media_bypass_policy_t? media_bypass_policy=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls on adjacencies in this account. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute bool? media_bypass_policy_use_default=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls on adjacencies in this account. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute perimeta::account::call_media_policy_active_call_bypass_t? active_call_bypass=null

Determines whether the Session Controller permits media bypass for active calls on adjacencies in this account, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls on accounts containing adjacencies that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls on accounts containing adjacencies that are used to connect to the endpoints in calls.

attribute bool? active_call_bypass_use_default=null

Determines whether the Session Controller permits media bypass for active calls on adjacencies in this account, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls on accounts containing adjacencies that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls on accounts containing adjacencies that are used to connect to the endpoints in calls.

attribute bool? supported_codecs_use_default=null

Sets a codec allowlist to use with adjacencies in this account. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? preferred_codecs_use_default=null

Sets a codec preference list to use with adjacencies in this account. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? non_audio_video_codecs_use_default=null

Sets a codec allowlist for non audio/video media streams to use with adjacencies in this account. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

attribute bool? preferred_payload_types_use_default=null

Sets the RTP payload type preference list to use with adjacencies in this account. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on adjacencies in this account.

attribute perimeta::account::call_media_policy_comfort_noise_codec_t? comfort_noise_codec=null

Specifies whether the Session Controller should perform comfort noise interworking for calls on this account. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? comfort_noise_codec_use_default=null

Specifies whether the Session Controller should perform comfort noise interworking for calls on this account. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? transcoding=null

Enables transcoding calls on this account. The Session Controller performs transcoding to interwork between different media codecs on the two legs of a call, allowing support for calls between devices that do not share supported codecs. See Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html) for more information.

attribute perimeta::account::call_media_policy_transcoding_trigger_t? transcoding_trigger=null

Sets the transcoding trigger for this account, which controls when calls enter transcoding mode. Transcoding mode means Perimeta will add codecs that require transcoding to SDP offers; it does not always mean the call will necessarily use transcoding, since endpoints can select a non-transcoding codec. For more details see Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? answer_generation_match_fidelity=null

Specifies that the Session Controller should choose a codec for its answer to the inbound offer that causes the same fidelity (standard definition (SD) or high definition (HD)) to be used on each side of the call when transcoding and using this account. This is only possible if the inbound offer contained both SD and HD codecs. You must set this on the caller’s side of the call. If the caller offers both SD and HD codecs, you can use this to prevent SD-to-HD or HD-to-SD transcoding. These combinations use more resources than SD-to-SD transcoding and provide worse call quality than HD-to-HD transcoding. For more information, see Matching codec fidelities in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? tty_interwork_from_rfc4103=null

Specifies whether the Session Controller should interwork between RFC 4103 Real-Time Text (RTT) and Text Telephone (TTY). The Session Controller always initially passes through an RTT offer. If this configuration is set, the Session Controller initiates interworking after receiving either a 200 with a disabled text media stream or no text media stream present, a 415, or a 488 response to an RTT offer. This feature is only available on systems with software transcoding enabled. For more information on configuring Perimeta to interwork from RTT to TTY, see RTT and TTY interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTTAndTTYInterworking.html).

attribute perimeta::account::call_media_policy_fax_transcoding_t? fax_transcoding=null

Enables fax transcoding on this account and specifies the fax transport protocol for the Session Controller to use for this account. If you select T.38, the Session Controller will use T.38 for fax calls if possible, but will use G.711 if T.38 is not available. If you select G.711, the Session Controller will never use T.38 for fax calls on this account. For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::account::call_media_policy_fax_transcoding_default_pcm_type_t? fax_transcoding_default_pcm_type=null

Specifies the PCM variant that the Session Controller must use when generating a fax transcoding offer.

attribute perimeta::account::call_media_policy_fax_transcoding_jitter_buffer_size_t? fax_transcoding_jitter_buffer_size=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute bool? fax_transcoding_jitter_buffer_size_use_default=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute perimeta::account::call_media_policy_fax_transcoding_generate_reinvite_t? fax_transcoding_generate_reinvite=null

Specifies whether the Session Controller should detect fax tones on G.711 calls made through this account and generate T.38 reINVITEs when required. If you set this Property to enabled, the Session Controller will generate a T.38 reINVITE on detection of a V.21 flag from the receiving fax machine or gateway. If you set this Property to on-cng, the Session Controller will generate a T.38 reINVITE on detection of a CNG tone from either side of the fax call.

attribute bool? fax_transcoding_retry_on_4xx=null

Specifies that the Session Controller should invoke fax transcoding and use G.711 on this account’s leg of the call if it receives a 4xx response to an original T.38 offer. You must only set this Property to true if the Session Controller is configured to use T.38 for fax transcoding on this account.

attribute perimeta::account::call_media_policy_fax_transcoding_tone_detection_mode_t? fax_transcoding_tone_detection_mode=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute bool? fax_transcoding_tone_detection_mode_use_default=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::account::call_media_policy_inband_tones_t? inband_tones=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints on this account. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tones_use_default=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints on this account. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute perimeta::account::call_media_policy_inband_tone_interworking_t? inband_tone_interworking=null

Enables or disables inband DTMF interworking. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tone_interworking_use_default=null

Enables or disables inband DTMF interworking. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? repeat_sdp_on_18x=null

Configures the Session Controller to add a repeat of the agreed SDP to provisional “18x” responses after the initial successful INVITE offer-answer exchange for calls made from this account. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute bool? repeat_sdp_on_200ok=null

Configures the Session Controller to add a repeat of the agreed SDP to the 200 OK response for calls made from this account. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute perimeta::account::call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t? session_refresh_sdp_renegotiation_on_pass_through=null

Configures whether the Session Controller supports SDP renegotiation on adjacencies using this account if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices connecting to the Session Controller on adjacencies in this account to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation on adjacencies that will handle calls using paired media bypass. If you set this command to ‘inherit’, the account will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute bool? session_refresh_sdp_renegotiation_on_pass_through_use_default=null

Configures whether the Session Controller supports SDP renegotiation on adjacencies using this account if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices connecting to the Session Controller on adjacencies in this account to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation on adjacencies that will handle calls using paired media bypass. If you set this command to ‘inherit’, the account will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute perimeta::account::call_media_policy_hold_indicator_t? hold_indicator=null

Sets the method or combination of methods that the Session Controller should use when signaling call hold to endpoints in this account. The default (when no configured policy applies) is standard. For more information, see Call hold interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallHoldInterworking.html).

attribute bool? ignore_sdp_bandwidth_fields=null

Configures the Session Controller to ignore ‘b=’ lines in SDP and to calculate bandwidth requirements for a call based on the codecs used. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::account::call_media_policy_secure_media_t? secure_media=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this account. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? secure_media_use_default=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this account. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? strip_all_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all disabled media descriptions from SDP offers on this account.

attribute bool? strip_new_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all new disabled media descriptions from SDP offers on this account. New streams are those that are unknown to the recipient. All streams in an initial offer are new, as are any streams added to a reoffer.

attribute bool? strip_disabled_media_descriptions_from_answers=null

Specifies whether the Session Controller will strip all disabled media descriptions from forwarded answers on this account. Note that setting this Property to true violates RFC 3264.

attribute bool? disabled_media_descriptions_pad_offers=null

Specifies whether the Session Controller will pad reoffers on this account with dummy media lines to replace lines removed by the sender.

attribute perimeta::account::call_media_policy_early_media_timeout_t? early_media_timeout=null

Sets a maximum length of time for which early media is allowed. If the call is not connected within this time period, it will be torn down.

attribute bool? early_media_timeout_use_default=null

Sets a maximum length of time for which early media is allowed. If the call is not connected within this time period, it will be torn down.

attribute perimeta::account::call_media_policy_early_media_p_early_media_t? early_media_p_early_media=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this account.

attribute bool? early_media_p_early_media_use_default=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this account.

attribute perimeta::account::call_media_policy_bandwidth_policing_mode_t? bandwidth_policing_mode=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? bandwidth_policing_mode_use_default=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::account::call_media_policy_force_ptime_t? force_ptime=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute bool? force_ptime_use_default=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute perimeta::account::call_media_policy_force_ptime_value_t? force_ptime_value=null

Specifies the packetization time (in milliseconds) to be used on this side of the call.

attribute perimeta::account::call_media_policy_rtcp_suppression_t? rtcp_suppression=null

Specifies how the Session Controller should handle RTCP packets for calls using account. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute bool? rtcp_suppression_use_default=null

Specifies how the Session Controller should handle RTCP packets for calls using account. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute perimeta::account::call_media_policy_rtcp_multiplexing_t? rtcp_multiplexing=null

Enables RTP/RTCP multiplexing on calls using this account. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute bool? rtcp_multiplexing_use_default=null

Enables RTP/RTCP multiplexing on calls using this account. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute perimeta::account::call_media_policy_rtcp_xr_block_types_t? rtcp_xr_block_types=null

Specifies any requested RTCP-XR block types on this account

attribute perimeta::account::call_media_policy_media_latching_t? media_latching=null

Specifies whether media latching should be disabled for traffic on this account. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute bool? media_latching_use_default=null

Specifies whether media latching should be disabled for traffic on this account. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_t? all_calls_jitter_buffer=null

Controls whether a jitter buffer is enabled for all calls on this account. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute bool? all_calls_jitter_buffer_use_default=null

Controls whether a jitter buffer is enabled for all calls on this account. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_size_t? all_calls_jitter_buffer_size=null

Set the fixed size (Fixed Mode) or initial size (Adaptive mode) for the jitter buffer in milliseconds

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_max_size_t? all_calls_jitter_buffer_max_size=null

Specifies the maximum capacity of the all calls jitter buffer.

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_min_size_t? all_calls_jitter_buffer_min_size=null

Specifies the minimum capacity of the all calls jitter buffer.

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_step_size_t? all_calls_jitter_buffer_step_size=null

Specifies the size by which the capacity of the all calls jitter buffer should change in response to packet delay variation.

attribute perimeta::account::call_media_policy_all_calls_jitter_buffer_step_rate_t? all_calls_jitter_buffer_step_rate=null

Specifies how frequently the capacity of the all calls jitter buffer should change. This is expressed as a percentage of the size of the buffer.

attribute perimeta::account::call_media_policy_media_capture_percentage_t? media_capture_percentage=null

Configures the probability that the media for an individual call in this account is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute bool? media_capture_percentage_use_default=null

Configures the probability that the media for an individual call in this account is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute perimeta::account::call_media_policy_media_timeout_t? media_timeout=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute bool? media_timeout_use_default=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute perimeta::account::call_media_policy_remove_csrc_t? remove_csrc=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool? remove_csrc_use_default=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel supported_codecs: Sets a codec allowlist to use with adjacencies in this account. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel preferred_codecs: Sets a codec preference list to use with adjacencies in this account. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel non_audio_video_codecs: Sets a codec allowlist for non audio/video media streams to use with adjacencies in this account. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html). :rel preferred_payload_types: Sets the RTP payload type preference list to use with adjacencies in this account. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on adjacencies in this account. :rel offer_generation_codec_template: Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers. :rel qos_sig_profile: Sets a Quality of Service profile to apply to signaling packets routed into this account. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_video_profile: Sets a Quality of Service profile to apply to video media packets routed into this account. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_voice_profile: Sets a Quality of Service profile to apply to voice media packets routed into this account. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_msrp_profile: Sets a Quality of Service profile to apply to MSRP media packets routed into this account. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

relation perimeta::codec_list::CodecListIdentity supported_codecs [0:1]

Sets a codec allowlist to use with adjacencies in this account. For more information, see Codec lists in Perimeta

Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_codecs [0:1]

Sets a codec preference list to use with adjacencies in this account. For more information, see Codec lists in Perimeta

Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity non_audio_video_codecs [0:1]

Sets a codec allowlist for non audio/video media streams to use with adjacencies in this account. The only current non

audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_payload_types [0:1]

Sets the RTP payload type preference list to use with adjacencies in this account. An RTP payload type preference list

allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on adjacencies in this account.

Peer relation:

relation perimeta::codec_list::CodecListIdentity offer_generation_codec_template [0:1]

Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers. If you do not use

this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers.

Peer relation:

relation perimeta::qos::SigIdentity qos_sig_profile [0:1]

Sets a Quality of Service profile to apply to signaling packets routed into this account. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VideoIdentity qos_video_profile [0:1]

Sets a Quality of Service profile to apply to video media packets routed into this account. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VoiceIdentity qos_voice_profile [0:1]

Sets a Quality of Service profile to apply to voice media packets routed into this account. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::MsrpIdentity qos_msrp_profile [0:1]

Sets a Quality of Service profile to apply to MSRP media packets routed into this account. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::account::call_media_policy_config

• perimeta::account::call_media_policy_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::call_media_policy_config, perimeta::account::call_media_policy_cross_device_relations constraint true

entity perimeta::account::CallMediaPolicyIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/call-media-policy Perimeta API resource. Abstract base entity. For concrete usage, see children CallMediaPolicy and CallMediaPolicyUnmanaged.

Configuration mode for call media policies affecting calls through this account. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). Account settings will only apply when no specific setting is configured for a particular adjacency.

relation perimeta::account::AccountIdentity account [1]

other end: perimeta::account::AccountIdentity.call_media_policy [0:1]

The following implementations are defined for this entity:

• perimeta::account::call_media_policy_uri

The following implements statements select implementations for this entity:

• perimeta::account::call_media_policy_uri constraint true

entity perimeta::account::CallMediaPolicyUnmanaged

Parents: perimeta::account::CallMediaPolicyIdentity

Unmanaged reference to a /account/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls through this account. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). Account settings will only apply when no specific setting is configured for a particular adjacency.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::TrafficGroup

Parents: perimeta::account::TrafficGroupIdentity, std::PurgeableResource

Inmanta resource to manage a /account/traffic-group Perimeta API resource.

Creates a traffic group on this account or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this account, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::traffic_group_config

• perimeta::account::traffic_group_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_config, perimeta::account::traffic_group_cross_device_relations constraint true

entity perimeta::account::TrafficGroupCallLimits

Parents: perimeta::account::TrafficGroupCallLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /account/traffic-group/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::traffic_group_call_limits_max_bandwidth_t? max_bandwidth=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this traffic group. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? max_bandwidth_use_default=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this traffic group. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::account::traffic_group_call_limits_max_call_duration_t? max_call_duration=null

Set the maximum duration in seconds for a call on this traffic group.

attribute bool? max_call_duration_use_default=null

Set the maximum duration in seconds for a call on this traffic group.

attribute perimeta::account::traffic_group_call_limits_media_streams_t? media_streams=null

Sets a maximum number of media streams per call for this traffic group.

attribute bool? media_streams_use_default=null

Sets a maximum number of media streams per call for this traffic group.

attribute perimeta::account::traffic_group_call_limits_max_media_renegotiations_t? max_media_renegotiations=null

Sets the maximum number of media renegotiations per call for this traffic group.

attribute bool? max_media_renegotiations_use_default=null

Sets the maximum number of media renegotiations per call for this traffic group.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::traffic_group_call_limits_config

• perimeta::account::traffic_group_call_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_call_limits_config, perimeta::account::traffic_group_call_limits_cross_device_relations constraint true

entity perimeta::account::TrafficGroupCallLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/traffic-group/call-limits Perimeta API resource. Abstract base entity. For concrete usage, see children TrafficGroupCallLimits and TrafficGroupCallLimitsUnmanaged.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

relation perimeta::account::TrafficGroupIdentity traffic_group [1]

other end: perimeta::account::TrafficGroupIdentity.call_limits [0:1]

The following implementations are defined for this entity:

• perimeta::account::traffic_group_call_limits_uri

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_call_limits_uri constraint true

entity perimeta::account::TrafficGroupCallLimitsUnmanaged

Parents: perimeta::account::TrafficGroupCallLimitsIdentity

Unmanaged reference to a /account/traffic-group/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::TrafficGroupCallMediaPolicy

Parents: perimeta::account::TrafficGroupCallMediaPolicyIdentity, std::PurgeableResource

Inmanta resource to manage a /account/traffic-group/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls on this account with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant account setting will be applied if the account has the setting configured (or the account setting, if the setting has not been configured on the account and the account is part of an account on which the setting has been configured).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::traffic_group_call_media_policy_ice_lite_t? ice_lite=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this traffic group. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute bool? ice_lite_use_default=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this traffic group. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute perimeta::account::traffic_group_call_media_policy_media_bypass_policy_t? media_bypass_policy=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls using this traffic group. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute bool? media_bypass_policy_use_default=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls using this traffic group. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute perimeta::account::traffic_group_call_media_policy_active_call_bypass_t? active_call_bypass=null

Determines whether the Session Controller permits media bypass for active calls using this traffic group, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls using traffic groups that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls using traffic groups that are used to connect to the endpoints in calls.

attribute bool? active_call_bypass_use_default=null

Determines whether the Session Controller permits media bypass for active calls using this traffic group, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls using traffic groups that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls using traffic groups that are used to connect to the endpoints in calls.

attribute bool? supported_codecs_use_default=null

Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? preferred_codecs_use_default=null

Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? non_audio_video_codecs_use_default=null

Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

attribute bool? preferred_payload_types_use_default=null

Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group.

attribute perimeta::account::traffic_group_call_media_policy_comfort_noise_codec_t? comfort_noise_codec=null

Specifies whether the Session Controller should perform comfort noise interworking for calls using this traffic group. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? comfort_noise_codec_use_default=null

Specifies whether the Session Controller should perform comfort noise interworking for calls using this traffic group. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? transcoding=null

Enables transcoding for calls using this traffic group. See Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html) for more information.

attribute perimeta::account::traffic_group_call_media_policy_transcoding_trigger_t? transcoding_trigger=null

Sets the transcoding trigger for this traffic group, which controls when calls enter transcoding mode. Transcoding mode means Perimeta will add codecs that require transcoding to SDP offers; it does not always mean the call will necessarily use transcoding, since endpoints can select a non-transcoding codec. For more details see Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? answer_generation_match_fidelity=null

Specifies that the Session Controller should choose a codec for its answer to the inbound offer that causes the same fidelity (standard definition (SD) or high definition (HD)) to be used on each side of the call when transcoding and using this traffic group. This is only possible if the inbound offer contained both SD and HD codecs. You must set this on the caller’s side of the call. If the caller offers both SD and HD codecs, you can use this to prevent SD-to-HD or HD-to-SD transcoding. These combinations use more resources than SD-to-SD transcoding and provide worse call quality than HD-to-HD transcoding. For more background information, see Matching codec fidelities in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? tty_interwork_from_rfc4103=null

Specifies whether the Session Controller should interwork between RFC 4103 Real-Time Text (RTT) and Text Telephone (TTY). The Session Controller always initially passes through an RTT offer. If this configuration is set, the Session Controller initiates interworking after receiving either a 200 with a disabled text media stream or no text media stream present, a 415, or a 488 response to an RTT offer. This feature is only available on systems with software transcoding enabled. For more information on configuring Perimeta to interwork from RTT to TTY, see RTT and TTY interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTTAndTTYInterworking.html).

attribute perimeta::account::traffic_group_call_media_policy_fax_transcoding_t? fax_transcoding=null

Enables fax transcoding on calls using this traffic group and specifies the fax transport protocol for the Session Controller to use. If you select T.38, the Session Controller will use T.38 for fax calls if possible, but will use G.711 if T.38 is not available. If you select G.711, the Session Controller will never use T.38 for fax calls using this traffic group. For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::account::traffic_group_call_media_policy_fax_transcoding_default_pcm_type_t? fax_transcoding_default_pcm_type=null

Specifies the PCM variant that the Session Controller must use when generating a fax transcoding offer for calls using this traffic group.

attribute perimeta::account::traffic_group_call_media_policy_fax_transcoding_jitter_buffer_size_t? fax_transcoding_jitter_buffer_size=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute bool? fax_transcoding_jitter_buffer_size_use_default=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute perimeta::account::traffic_group_call_media_policy_fax_transcoding_generate_reinvite_t? fax_transcoding_generate_reinvite=null

Specifies whether the Session Controller should detect fax tones on G.711 calls made through this traffic group and generate T.38 reINVITEs when required. If you set this Property to enabled, the Session Controller will generate a T.38 reINVITE on detection of a V.21 flag from the receiving fax machine or gateway. If you set this Property to on-cng, the Session Controller will generate a T.38 reINVITE on detection of a CNG tone from either side of the fax call.

attribute bool? fax_transcoding_retry_on_4xx=null

Specifies that the Session Controller should invoke fax transcoding and use G.711 on this traffic groups’s leg of the call if it receives a 4xx response to an original T.38 offer. You must only set this Property to true if the Session Controller is configured to use T.38 for fax transcoding on this traffic group.

attribute perimeta::account::traffic_group_call_media_policy_fax_transcoding_tone_detection_mode_t? fax_transcoding_tone_detection_mode=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute bool? fax_transcoding_tone_detection_mode_use_default=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::account::traffic_group_call_media_policy_inband_tones_t? inband_tones=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints when this traffic group is applied to a call. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. For more information, see DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html).

attribute bool? inband_tones_use_default=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints when this traffic group is applied to a call. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. For more information, see DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html).

attribute perimeta::account::traffic_group_call_media_policy_inband_tone_interworking_t? inband_tone_interworking=null

Enables or disables inband DTMF interworking for this side of a call with this traffic group applied. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tone_interworking_use_default=null

Enables or disables inband DTMF interworking for this side of a call with this traffic group applied. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? repeat_sdp_on_18x=null

Configures the Session Controller to add a repeat of the agreed SDP to provisional “18x” responses after the initial successful INVITE offer-answer exchange for calls made using this traffic group on the outbound side. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute bool? repeat_sdp_on_200ok=null

Configures the Session Controller to add a repeat of the agreed SDP to the 200 OK response for calls made using this traffic group on the outbound side. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute perimeta::account::traffic_group_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t? session_refresh_sdp_renegotiation_on_pass_through=null

Configures whether the Session Controller supports SDP renegotiation on calls using this traffic group if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices involved in calls on this traffic group to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation if this traffic group will be used for calls using paired media bypass. If you set this command to ‘inherit’, the traffic group will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute bool? session_refresh_sdp_renegotiation_on_pass_through_use_default=null

Configures whether the Session Controller supports SDP renegotiation on calls using this traffic group if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices involved in calls on this traffic group to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation if this traffic group will be used for calls using paired media bypass. If you set this command to ‘inherit’, the traffic group will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute perimeta::account::traffic_group_call_media_policy_hold_indicator_t? hold_indicator=null

Sets the method or combination of methods that the Session Controller should use when signaling call hold to endpoints in this traffic group. The default (when no configured traffic group applies) is standard. For more information, see Call hold interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallHoldInterworking.html).

attribute bool? ignore_sdp_bandwidth_fields=null

Configures the Session Controller to ignore ‘b=’ lines in SDP and to calculate bandwidth requirements for a call based on the codecs used when this traffic group is applied. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::account::traffic_group_call_media_policy_secure_media_t? secure_media=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this traffic group. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? secure_media_use_default=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this traffic group. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? strip_all_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all disabled media descriptions from SDP offers using this traffic group.

attribute bool? strip_new_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all new disabled media descriptions from SDP offers using this traffic group. New streams are those that are unknown to the recipient. All streams in an initial offer are new, as are any streams added to a reoffer.

attribute bool? strip_disabled_media_descriptions_from_answers=null

Specifies whether the Session Controller will strip all disabled media descriptions from forwarded answers using this traffic group. Note that setting this Property to true violates RFC 3264.

attribute bool? disabled_media_descriptions_pad_offers=null

Specifies whether the Session Controller will pad reoffers on this traffic group with dummy media lines to replace lines removed by the sender.

attribute perimeta::account::traffic_group_call_media_policy_early_media_timeout_t? early_media_timeout=null

Sets a maximum length of time for which early media is allowed on calls when this traffic group is applied. If the call is not connected within this time period, it will be torn down.

attribute bool? early_media_timeout_use_default=null

Sets a maximum length of time for which early media is allowed on calls when this traffic group is applied. If the call is not connected within this time period, it will be torn down.

attribute perimeta::account::traffic_group_call_media_policy_early_media_p_early_media_t? early_media_p_early_media=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this traffic group.

attribute bool? early_media_p_early_media_use_default=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this traffic group.

attribute perimeta::account::traffic_group_call_media_policy_bandwidth_policing_mode_t? bandwidth_policing_mode=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? bandwidth_policing_mode_use_default=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::account::traffic_group_call_media_policy_force_ptime_t? force_ptime=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute bool? force_ptime_use_default=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute perimeta::account::traffic_group_call_media_policy_force_ptime_value_t? force_ptime_value=null

Specific packetization time

attribute perimeta::account::traffic_group_call_media_policy_rtcp_suppression_t? rtcp_suppression=null

Specifies how the Session Controller should handle RTCP packets for calls using this traffic group. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute bool? rtcp_suppression_use_default=null

Specifies how the Session Controller should handle RTCP packets for calls using this traffic group. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute perimeta::account::traffic_group_call_media_policy_rtcp_multiplexing_t? rtcp_multiplexing=null

Enables RTP/RTCP multiplexing on calls using this account. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute bool? rtcp_multiplexing_use_default=null

Enables RTP/RTCP multiplexing on calls using this account. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute perimeta::account::traffic_group_call_media_policy_rtcp_xr_block_types_t? rtcp_xr_block_types=null

Specifies any requested RTCP-XR block types on this traffic group

attribute perimeta::account::traffic_group_call_media_policy_media_latching_t? media_latching=null

Specifies whether media latching should be disabled for traffic on this traffic group. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute bool? media_latching_use_default=null

Specifies whether media latching should be disabled for traffic on this traffic group. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_t? all_calls_jitter_buffer=null

Controls whether a jitter buffer is enabled for all calls in this traffic group. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute bool? all_calls_jitter_buffer_use_default=null

Controls whether a jitter buffer is enabled for all calls in this traffic group. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_size_t? all_calls_jitter_buffer_size=null

Set the fixed size (Fixed Mode) or initial size (Adaptive mode) for the jitter buffer in milliseconds

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_max_size_t? all_calls_jitter_buffer_max_size=null

Specifies the maximum capacity of the all calls jitter buffer.

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_min_size_t? all_calls_jitter_buffer_min_size=null

Specifies the minimum capacity of the all calls jitter buffer.

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_step_size_t? all_calls_jitter_buffer_step_size=null

Specifies the size by which the capacity of the all calls jitter buffer should change in response to packet delay variation.

attribute perimeta::account::traffic_group_call_media_policy_all_calls_jitter_buffer_step_rate_t? all_calls_jitter_buffer_step_rate=null

Specifies how frequently the capacity of the all calls jitter buffer should change. This is expressed as a percentage of the size of the buffer.

attribute perimeta::account::traffic_group_call_media_policy_media_capture_percentage_t? media_capture_percentage=null

Configures the probability that the media for an individual call in this traffic group is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute bool? media_capture_percentage_use_default=null

Configures the probability that the media for an individual call in this traffic group is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute perimeta::account::traffic_group_call_media_policy_media_timeout_t? media_timeout=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute bool? media_timeout_use_default=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute perimeta::account::traffic_group_call_media_policy_remove_csrc_t? remove_csrc=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool? remove_csrc_use_default=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel supported_codecs: Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel preferred_codecs: Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel non_audio_video_codecs: Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html). :rel preferred_payload_types: Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group. :rel offer_generation_codec_template: Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers for calls using this traffic group. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers. :rel qos_sig_profile: Sets a Quality of Service profile to apply to signaling packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_video_profile: Sets a Quality of Service profile to apply to video media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_voice_profile: Sets a Quality of Service profile to apply to voice media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_msrp_profile: Sets a Quality of Service profile to apply to MSRP media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

relation perimeta::codec_list::CodecListIdentity supported_codecs [0:1]

Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration

and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_codecs [0:1]

Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta

Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity non_audio_video_codecs [0:1]

Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current

non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_payload_types [0:1]

Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list

allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group.

Peer relation:

relation perimeta::codec_list::CodecListIdentity offer_generation_codec_template [0:1]

Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers for calls using

this traffic group. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers.

Peer relation:

relation perimeta::qos::SigIdentity qos_sig_profile [0:1]

Sets a Quality of Service profile to apply to signaling packets routed into this traffic group. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VideoIdentity qos_video_profile [0:1]

Sets a Quality of Service profile to apply to video media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VoiceIdentity qos_voice_profile [0:1]

Sets a Quality of Service profile to apply to voice media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::MsrpIdentity qos_msrp_profile [0:1]

Sets a Quality of Service profile to apply to MSRP media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::account::traffic_group_call_media_policy_config

• perimeta::account::traffic_group_call_media_policy_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_call_media_policy_config, perimeta::account::traffic_group_call_media_policy_cross_device_relations constraint true

entity perimeta::account::TrafficGroupCallMediaPolicyIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/traffic-group/call-media-policy Perimeta API resource. Abstract base entity. For concrete usage, see children TrafficGroupCallMediaPolicy and TrafficGroupCallMediaPolicyUnmanaged.

Configuration mode for call media policies affecting calls on this account with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant account setting will be applied if the account has the setting configured (or the account setting, if the setting has not been configured on the account and the account is part of an account on which the setting has been configured).

relation perimeta::account::TrafficGroupIdentity traffic_group [1]

other end: perimeta::account::TrafficGroupIdentity.call_media_policy [0:1]

The following implementations are defined for this entity:

• perimeta::account::traffic_group_call_media_policy_uri

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_call_media_policy_uri constraint true

entity perimeta::account::TrafficGroupCallMediaPolicyUnmanaged

Parents: perimeta::account::TrafficGroupCallMediaPolicyIdentity

Unmanaged reference to a /account/traffic-group/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls on this account with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant account setting will be applied if the account has the setting configured (or the account setting, if the setting has not been configured on the account and the account is part of an account on which the setting has been configured).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::TrafficGroupIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/traffic-group Perimeta API resource. Abstract base entity. For concrete usage, see children TrafficGroup and TrafficGroupUnmanaged.

Creates a traffic group on this account or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this account, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

attribute perimeta::account::traffic_group_traffic_group_t traffic_group

Name of the traffic group. Specify a string of up to 22 alphanumeric characters.

relation perimeta::account::AccountIdentity account [1]

other end: perimeta::account::AccountIdentity.traffic_group [0:*]

relation perimeta::account::TrafficGroupCallMediaPolicyIdentity call_media_policy [0:1]

other end: perimeta::account::TrafficGroupCallMediaPolicyIdentity.traffic_group [1]

relation perimeta::account::TrafficGroupCallLimitsIdentity call_limits [0:1]

other end: perimeta::account::TrafficGroupCallLimitsIdentity.traffic_group [1]

relation perimeta::account::TrafficGroupTrafficGroupLimitsIdentity traffic_group_limits [0:*]

other end: perimeta::account::TrafficGroupTrafficGroupLimitsIdentity.traffic_group [1]

The following implementations are defined for this entity:

• perimeta::account::traffic_group_uri

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_uri constraint true

entity perimeta::account::TrafficGroupTrafficGroupLimits

Parents: perimeta::account::TrafficGroupTrafficGroupLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /account/traffic-group/traffic-group-limits Perimeta API resource.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::account::traffic_group_traffic_group_limits_call_appearances_t? call_appearances=null

Specifies the maximum number of concurrent calls permitted for this traffic group. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute bool? call_appearances_use_default=null

Specifies the maximum number of concurrent calls permitted for this traffic group. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute perimeta::account::traffic_group_traffic_group_limits_registrations_t? registrations=null

Sets a maximum number of concurrent registrations for this traffic group.

attribute bool? registrations_use_default=null

Sets a maximum number of concurrent registrations for this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_media_streams_t? media_streams=null

Sets the maximum number of media streams used by this traffic group at any one time.

attribute bool? media_streams_use_default=null

Sets the maximum number of media streams used by this traffic group at any one time.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_t? call_setup_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which call setup messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_value_t? call_setup_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-sustain-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_sustain_units_t? call_setup_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_t? call_setup_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this traffic group.

attribute bool? call_setup_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_value_t? call_setup_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-burst-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_call_setup_rate_max_burst_units_t? call_setup_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_t? in_call_message_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which in-call signaling messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_value_t? in_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-sustain-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_units_t? in_call_message_rate_max_sustain_units=null

Rate limit units (messages/time-period)

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_t? in_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this traffic group.

attribute bool? in_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_value_t? in_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-burst-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_in_call_message_rate_max_burst_units_t? in_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_t? out_of_call_message_rate_max_sustain=null

Specifies whether there is a limit on the sustain limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_value_t? out_of_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-sustain-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_units_t? out_of_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_t? out_of_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute bool? out_of_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_value_t? out_of_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-burst-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_units_t? out_of_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_t? regs_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate of registrations including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_value_t? regs_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-sustain-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_sustain_units_t? regs_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_t? regs_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute bool? regs_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this account. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_value_t? regs_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-burst-units Property.

attribute perimeta::account::traffic_group_traffic_group_limits_regs_rate_max_burst_units_t? regs_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::account::traffic_group_traffic_group_limits_max_bandwidth_t? max_bandwidth=null

Sets a maximum for the amount of bandwidth used by this traffic group at any one time.

attribute bool? max_bandwidth_use_default=null

Sets a maximum for the amount of bandwidth used by this traffic group at any one time.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::account::traffic_group_traffic_group_limits_config

• perimeta::account::traffic_group_traffic_group_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_traffic_group_limits_config, perimeta::account::traffic_group_traffic_group_limits_cross_device_relations constraint true

entity perimeta::account::TrafficGroupTrafficGroupLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /account/traffic-group/traffic-group-limits Perimeta API resource. Abstract base entity. For concrete usage, see children TrafficGroupTrafficGroupLimits and TrafficGroupTrafficGroupLimitsUnmanaged.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

attribute perimeta::account::traffic_group_traffic_group_limits_direction_t direction

Apply limits directionally

relation perimeta::account::TrafficGroupIdentity traffic_group [1]

other end: perimeta::account::TrafficGroupIdentity.traffic_group_limits [0:*]

The following implementations are defined for this entity:

• perimeta::account::traffic_group_traffic_group_limits_uri

The following implements statements select implementations for this entity:

• perimeta::account::traffic_group_traffic_group_limits_uri constraint true

entity perimeta::account::TrafficGroupTrafficGroupLimitsUnmanaged

Parents: perimeta::account::TrafficGroupTrafficGroupLimitsIdentity

Unmanaged reference to a /account/traffic-group/traffic-group-limits Perimeta API resource.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::account::TrafficGroupUnmanaged

Parents: perimeta::account::TrafficGroupIdentity

Unmanaged reference to a /account/traffic-group Perimeta API resource.

Creates a traffic group on this account or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this account, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::address_group::AddressGroup

Parents: perimeta::address_group::AddressGroupIdentity, std::PurgeableResource

Inmanta resource to manage a /address-group Perimeta API resource.

Configuration Resource for an address group. An address group contains a set of IP addresses for peers from which a SIP adjacency can accept traffic. You must apply an address group to an adjacency as a remote address group to use it.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::address_group::address_group_description_t? description=null

Sets a description for this address group. The description is used only for clarity when viewing information about the address group. For more information, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::address_group::address_group_config

• perimeta::address_group::address_group_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::address_group::address_group_config, perimeta::address_group::address_group_cross_device_relations constraint true

entity perimeta::address_group::AddressGroupIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /address-group Perimeta API resource. Abstract base entity. For concrete usage, see children AddressGroup and AddressGroupUnmanaged.

Configuration Resource for an address group. An address group contains a set of IP addresses for peers from which a SIP adjacency can accept traffic. You must apply an address group to an adjacency as a remote address group to use it.

attribute perimeta::address_group::address_group_address_group_name_t address_group_name

Name of the address group.

relation perimeta::address_group::IpAddressIdentity ip_address [0:*]

other end: perimeta::address_group::IpAddressIdentity.address_group [1]

The following implementations are defined for this entity:

• perimeta::address_group::address_group_uri

The following implements statements select implementations for this entity:

• perimeta::address_group::address_group_uri constraint true

entity perimeta::address_group::AddressGroupUnmanaged

Parents: perimeta::address_group::AddressGroupIdentity

Unmanaged reference to a /address-group Perimeta API resource.

Configuration Resource for an address group. An address group contains a set of IP addresses for peers from which a SIP adjacency can accept traffic. You must apply an address group to an adjacency as a remote address group to use it.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::address_group::IpAddress

Parents: perimeta::address_group::IpAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /address-group/ip-address Perimeta API resource.

Adds an IPv4 or IPv6 address to the parent address group. For more information, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html)

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::address_group::ip_address_config

• perimeta::address_group::ip_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::address_group::ip_address_config, perimeta::address_group::ip_address_cross_device_relations constraint true

entity perimeta::address_group::IpAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /address-group/ip-address Perimeta API resource. Abstract base entity. For concrete usage, see children IpAddress and IpAddressUnmanaged.

Adds an IPv4 or IPv6 address to the parent address group. For more information, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html)

attribute std::ipv_any_address ip_address

IP address

relation perimeta::address_group::AddressGroupIdentity address_group [1]

other end: perimeta::address_group::AddressGroupIdentity.ip_address [0:*]

The following implementations are defined for this entity:

• perimeta::address_group::ip_address_uri

The following implements statements select implementations for this entity:

• perimeta::address_group::ip_address_uri constraint true

entity perimeta::address_group::IpAddressUnmanaged

Parents: perimeta::address_group::IpAddressIdentity

Unmanaged reference to a /address-group/ip-address Perimeta API resource.

Adds an IPv4 or IPv6 address to the parent address group. For more information, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html)

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::Sip

Parents: perimeta::adjacency::SipIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip Perimeta API resource.

Configuration mode for a SIP adjacency (a SIP interface used by the Session Controller on a particular service network). For more information, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_description_t? description=null

Sets a description for this adjacency. The description is used only for clarity when viewing information about the adjacency.

attribute perimeta::adjacency::sip_adjacency_type_t? adjacency_type=null

Specifies the type of profile this adjacency will inherit. The Session Controller uses the adjacency type to select pre-configured default options for most adjacency settings, appropriate to the way the adjacency will be used. For information on the effects of the different types, see Configuring a SIP adjacency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAnAdjacency.html) and Adjacency types in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/AdjacencyTypes.html).

attribute perimeta::adjacency::sip_local_id_t? local_id=null

Sets the local identity for this adjacency. This can be an IP address or domain name (it must not contain a port number). The Session Controller uses this as the hostname in any rewritten From or Contact headers sent from this adjacency. It will also identify messages sent to this adjacency by matching the local identity to the hostname in the Request-URI or topmost Route header. By default, the Session Controller uses the local IP address for the adjacency, set using the signaling-local-address command.

attribute perimeta::adjacency::sip_collect_statistics_t? collect_statistics=null

Sets the level of detail for response code statistics recorded by the Session Controller on this adjacency. Typically you will always set this to ‘detailed’ unless advised to use a different setting by your customer support representative.

attribute perimeta::adjacency::sip_deactivation_mode_t? deactivation_mode=null

Specifies how the Session Controller should deal with in-progress calls when this adjacency is deactivated. You can use this command while an adjacency is deactivating to force calls to end by moving up to a more severe deactivation mode. For more information, see Deactivation modes in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DeactivationModes.html).

attribute perimeta::adjacency::sip_client_data_t? client_data=null

API clients can use this property to store information about the object.

attribute bool? activate=null

Specifies whether this adjacency is active. Setting this Property to false will cause the adjacency to deactivate in accordance with the deactivation-mode Property (see Deactivation modes in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DeactivationModes.html) for details). You can switch to a more severe deactivation mode setting during deactivation if you need to force calls to end.

attribute perimeta::adjacency::sip_service_address_t service_address

Sets the service address name for this adjacency. This identifies a particular service interface and local IP address that the Session Controller will use for this adjacency. The same service address name can select different local addresses on different Session Controllers if the adjacency is shared using geographic redundancy or MSC emergency standalone.

attribute perimeta::adjacency::sip_local_port_t? local_port=null

Sets whether the local port for this adjacency will be the default SIP port (5060, or 5061 if TLS is enabled on this adjacency), a specific single port or a specific port range. To avoid interoperability issues with MetaSphere Call Feature Server and certain other registrars, we recommend that you always specify a single port or port range, even if you intend to use 5060 or 5061. This causes Perimeta to explicitly state the port number in a Contact header. You cannot change this setting while the adjacency is active.

attribute perimeta::adjacency::sip_local_single_port_t? local_single_port=null

Specifies the local port that the Session Controller will use for this adjacency.

attribute perimeta::adjacency::sip_min_local_port_t? min_local_port=null

Specifies the first port in the local port range that the Session Controller will use for this adjacency.

attribute perimeta::adjacency::sip_max_local_port_t? max_local_port=null

Specifies the last port in the local port range that the Session Controller will use for this adjacency.

attribute perimeta::adjacency::sip_signaling_peer_t? signaling_peer=null

Sets the static signaling peer address for this adjacency. The signaling peer is any valid IP address (IPv4 or IPv6) or hostname. If you plan to force outbound SIP requests to this signaling peer (using the force-signaling-peer Property) or force the use of NAT traversal for endpoints using this adjacency (using the nat Property), the signaling peer must be an IP address (not a hostname). On an access adjacency, we recommend that you set this to the all-zero address and set the signaling-peer-port Property to 0; setting this to the all-zero address without setting the port to 0 can cause service problems. This is because access adjacencies are designed for use with registering endpoints, and thus peer locations are learned, not configured. All SIP traffic or out-of-dialog SIP traffic routed into the adjacency will be sent to the signaling peer. You cannot change this setting if the adjacency is active. You cannot set a value for this Property if you have already set a value for the signaling-peer-group Property.

attribute perimeta::adjacency::sip_signaling_peer_port_t? signaling_peer_port=null

The port to connect to on the static signaling peer. We recommend that you set this to 0 if you have set the signaling peer address to the all-zero address (normal for an access adjacency); not setting this to 0 can cause service problems because access adjacencies are designed for use with registering endpoints, and thus peer locations are learned, not configured. You cannot set a value for this Property if you have already set a value for the signaling-peer-group Property.

attribute bool? trust_signaling_peer=null

Trust traffic from the signaling peer

attribute std::ipv_any_address? remote_address_range_ip=null

Specifies a range of IPs of remote signaling peers that are contactable from this adjacency. SIP devices can only connect to the Session Controller from an IP address in the remote address range (or a remote address group) configured on the adjacency. If you configure the adjacency with remote address range 0.0.0.0, all source IP addresses will match this adjacency. The remote address range and local address must use the same addressing schema (IPv4 or IPv6). You cannot change this setting while the adjacency is active.

attribute perimeta::adjacency::sip_remote_address_range_prefix_length_t? remote_address_range_prefix_length=null

Specifies the prefix length for the remote address range. You cannot change this setting while the adjacency is active.

attribute bool? remote_address_range_trusted=null

Sets the remote address range as trusted to allow a known traffic source on an untrusted interface to send SIP messages other than REGISTERs without registering itself. This is only necessary for devices that do not register. You cannot change this setting while the adjacency is active.

attribute bool? remote_address_group_trusted=null

Trust the entire remote address range

attribute perimeta::adjacency::sip_dns_source_t? dns_source=null

Specifies the source address to use for DNS queries for requests on this adjacency (including SIP OPTIONS pings for peer groups). You can choose from the following. - Using the DNS configuration, including the DNS servers and method of choosing between multiple DNS servers, of the service interface on which this adjacency is configured. This is the default. - Using the DNS servers in the management network. - Sending requests from a specified service address to the DNS servers in the service network corresponding to the service interface on which the service interface is configured. The Session Controller uses the DNS servers and method of choosing between multiple DNS servers configured on the service interface. For more information, see DNS support in Perimeta Network Integration Guide (https://manuals.metaswitch.com/Perimeta/latest/NetworkIntegrationGuide/Source/Perimeta/Concepts/DNSSupport.html).

attribute perimeta::adjacency::sip_dns_source_service_address_t? dns_source_service_address=null

Specifies the service address to use as the source of DNS queries for requests on this adjacency

attribute perimeta::adjacency::sip_simple_routing_t? simple_routing=null

Specifies whether the Session Controller will use simple routing to route traffic through this adjacency. If simple routing is enabled, the Session Controller will forward all messages received on this adjacency over the adjacency specified using the simple-routing-adjacency Property.

attribute perimeta::adjacency::sip_mandate_transport_t? mandate_transport=null

Sets a mandated transport protocol to use for connections to endpoints in this adjacency. If this setting is not configured, the Session Controller will use standard SIP transport selection. For more information, see Configuring a mandated or preferred transport protocol for outbound SIP traffic in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPreferredTransportProtocolForOutboundSIPTraffic.html).

attribute perimeta::adjacency::sip_nat_t? nat=null

Enables NAT traversal for endpoints in this adjacency. You can set the Session Controller to assume all endpoints are behind NAT or to attempt to detect whether they are. For information on how the Session Controller deals with endpoints that are behind NAT, see NAT detection and traversal in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/NATDetectionAndTraversal.html). By default, NAT traversal is disabled. You cannot change this setting while the adjacency is active.

attribute perimeta::adjacency::sip_listen_for_transports_t? listen_for_transports=null

Configures whether the Session Controller will listen for TCP traffic, UDP traffic, or both on this adjacency. Defaults to both, unless the adjacency is configured as a TLS adjacency, in which case the default is TCP only. You cannot change this setting while the adjacency is active.

attribute bool? listen_on_udp=null

Specifies whether the Session Controller will listen for UDP traffic on this adjacency.

attribute bool? listen_on_tcp=null

Specifies whether the Session Controller will listen for TCP traffic on this adjacency.

attribute perimeta::adjacency::sip_tls_t? tls=null

Specifies whether TLS is enabled on this adjacency. If TLS is enabled, the Session Controller will only use this adjacency for TLS traffic: you can configure another adjacency using the same local address and a different local port for non-TLS traffic if necessary. By default, the Session Controller will use 5061 as the local port for TLS adjacencies, but you can override this using the local-single-port Property or the min-local-port and max-local port Properties if you are using a port range. For more information see TLS support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TLSSupport.html).

attribute perimeta::adjacency::sip_tls_fqdn_t? tls_fqdn=null

Specifies the fully-qualified domain name (FQDN) of the peer to which this adjacency will connect using TLS. This must be the exact FQDN on the security certificate of the peer, including any wildcard asterisk ( * ) characters. If this peering adjacency uses a peer group, all of the peers in the peer group must use the same FQDN.

attribute perimeta::adjacency::sip_tls_certificate_t? tls_certificate=null

Sets the local TLS certificate to use for this adjacency, if more than one certificate has been configured. This command can be used on peering and access adjacencies; for more information, see Configuring TLS on a peering adjacency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSOnAPeeringAdjacency.html) or Configuring TLS on a access adjacency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSOnAnAccessAdjacency.html). For general information on security certificates, see Security certificates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityCertificates.html).

attribute perimeta::adjacency::sip_tls_public_ca_store_t? tls_public_ca_store=null

Sets the CA certificate store to use for this adjacency, if more than one CA store has been configured. This command can be used on peering adjacencies. It has no effect on access adjacencies. For more information, see Configuring TLS on a peering adjacency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSOnAPeeringAdjacency.html). For general information on security certificates, see Security certificates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityCertificates.html).

attribute perimeta::adjacency::sip_force_signaling_peer_t? force_signaling_peer=null

Routes either all outbound SIP requests or all outbound out-of-dialog and dialog-creating requests on this adjacency to the static signaling peer or peer group. To use this setting, the signaling peer(s) must be configured as IP addresses and not via a hostname. This setting is ignored for load-balancing redirections. For full details of how SIP messages are routed, see IP routing process for outbound SIP messages in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/IPRoutingProcessForOutboundSIPMessages.html).

attribute perimeta::adjacency::sip_redirect_mode_t? redirect_mode=null

Sets whether the Session Controller should pass through all 3XX responses to INVITEs or do some redirections itself, without notifying the caller. By default, the Session Controller will pass through all 3XX responses. If you configure this setting as recurse and also configure 3xx-embedded-header-passthrough-mode replace, the Session Controller does not perform standard behavior on load-balancing redirects. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html).

attribute bool? redirect_mode_use_default=null

Sets whether the Session Controller should pass through all 3XX responses to INVITEs or do some redirections itself, without notifying the caller. By default, the Session Controller will pass through all 3XX responses. If you configure this setting as recurse and also configure 3xx-embedded-header-passthrough-mode replace, the Session Controller does not perform standard behavior on load-balancing redirects. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html).

attribute perimeta::adjacency::sip_dynamic_routing_domain_match_t? dynamic_routing_domain_match=null

Sets the matching domain for dynamic domain routing to this adjacency. If you have enabled dynamic domain routing to the adjacency but do not provide a value for this setting, the Session Controller will use the signaling peer (or signaling peer group’s hostname) as the match domain. For more information see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html).

attribute perimeta::adjacency::sip_privacy_t? privacy=null

Sets whether the Session Controller should treat the adjacency as trusted for the purposes of SIP privacy. If the adjacency is untrusted, the Session Controller will strip user identifiers from SIP messages with a Privacy header before forwarding them into the adjacency. For more information, see SIP privacy support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPPrivacySupport.html). By default, core and IBCF adjacency types are privacy-trusted and all others are privacy-untrusted.

attribute perimeta::adjacency::sip_contact_header_username_t? contact_header_username=null

Determines whether the Session Controller rewrites or passes through the Contact header username on SIP messages. You can conceal your network topology by configuring the Session Controller to rewrite the Contact header username. Alternatively, you may need to configure the Session Controller to passthrough Contact header usernames to interoperate with registrars that require it to match the username in To and From headers. For more information, see Contact username handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/REGISTERUsernamePassthrough.html).

attribute bool? contact_username_unique_port_num=null

Use a unique port number for different contact for a given subscriber

attribute perimeta::adjacency::sip_msc_fallback_t? msc_fallback=null

Specifies the MSC fallback behavior for this adjacency. MSC fallback allows an SSC to select non-optimal MSCs for calls on a particular adjacency if no optimal MSCs are available due to congestion or MSC failure.

attribute perimeta::adjacency::sip_msc_location_id_t? msc_location_id=null

Sets the media location ID for this adjacency. The Session Controller uses the location ID to select the correct MSC for media traffic to and from the adjacency. For more information, see Media locations in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaLocations.html). You cannot change this setting while the adjacency is active. If you do not need to send traffic from different geographic locations or different types of traffic to different MSCs, the default configuration (a media location ID of default) on your adjacencies and your MSCs will be appropriate. Adjacencies with a core adjacency type are automatically assigned media location 0 (equivalent to any). If you try to configure media locations on your core adjacencies, your configuration will be ignored.

attribute perimeta::adjacency::sip_msc_location_id_value_t? msc_location_id_value=null

Sets a specific media location ID for this adjacency.

attribute perimeta::adjacency::sip_media_bypass_tags_t? media_bypass_tags=null

Sets media bypass tags for this adjacency. These are used to identify adjacencies between which media traffic can flow directly, making media bypass possible. By default, the Session Controller uses a tag based on the service network ID of the adjacency (allowing media bypass between all adjacencies with media bypass enabled on the same service network). For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html). You must provide your chosen media bypass tags as a comma-separated list.

attribute perimeta::adjacency::sip_realm_t? realm=null

Sets the media realm for this adjacency. This is used to associate the adjacency with media addresses. The realm name is not case sensitive. This is only required if endpoints in this adjacency will use either an MSC or a different service network for media relay. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

attribute bool? outbound_flood_policing=null

Specifies whether there is a maximum rate at which the Session Controller will send SIP requests out over this adjacency. If this Property is set to true, you must also specify this maximum rate in SIP requests per second using the outbound-flood-rate Property. For more information, see Outbound flood protection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/OutboundFloodProtection.html).

attribute perimeta::adjacency::sip_outbound_flood_rate_t? outbound_flood_rate=null

Specifies the maximum rate at which the Session Controller will send SIP requests out over this adjacency in SIP requests per second. For more information, see Outbound flood protection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/OutboundFloodProtection.html).

attribute bool? registration_required=null

Specifies whether endpoints on this adjacency need to be registered before they can initiate non-emergency calls or send out-of-dialog messages.

attribute perimeta::adjacency::sip_registration_contact_match_t? registration_contact_match=null

The contact policing setting. Determines whether strict or permissive contact policing will be applied to the adjacency. In particular, this field will change which messages are rejected when registration policing is enabled by registration-required. In the case of strict contact policing, requests will only be matched to a subscription based on the Contact header. An exception is only made if the Contact header contains a GRUU, in which case matching falls back to the P-Preferred-Identity and From headers. In the case of permissive policing, requests will be matched to a subscription based on the Contact header, but if this is not successful matching will be attempted based on the P-Preferred-Identity and From headers.

attribute bool? registration_contact_match_use_default=null

The contact policing setting. Determines whether strict or permissive contact policing will be applied to the adjacency. In particular, this field will change which messages are rejected when registration policing is enabled by registration-required. In the case of strict contact policing, requests will only be matched to a subscription based on the Contact header. An exception is only made if the Contact header contains a GRUU, in which case matching falls back to the P-Preferred-Identity and From headers. In the case of permissive policing, requests will be matched to a subscription based on the Contact header, but if this is not successful matching will be attempted based on the P-Preferred-Identity and From headers.

attribute perimeta::adjacency::sip_registration_outgoing_timer_t? registration_outgoing_timer=null

The default expiry time (in seconds) for outgoing REGISTER requests on this adjacency.

attribute bool? registration_outgoing_negotiate_local_expiry=null

Enables core-side REGISTER expiry time negotiation for this adjacency, allowing the Session Controller to negotiate the core-side expiry time with the registrar. This allows the registrar to negotiate extended registration periods on the core side, while the Session Controller maintains more regular registrations using fast-registration on the access side. If this setting is enabled on a registrar-facing adjacency, the Session Controller will handle REGISTERs for fast-registering subscribers as follows. - When the Session Controller forwards the REGISTER to the registrar, it sets the expiry time to 3000 seconds. This ensures that the registrar can negotiate the expiry time while complying with RFC 3261, which requires that the expiry time be less than 3600 seconds to allow a 423 response. - If the registrar sends a 423 response, the Session Controller re-sends the REGISTER with the increased expiry time given in the response. It does not forward the response to the subscriber. - When the registrar sends a 200 OK response, the Session Controller modifies the expiry time to the fast-registration time before forwarding it to the subscriber, as normal. The negotiation on the core side has no effect on the access side.

attribute perimeta::adjacency::sip_trunk_group_t? trunk_group=null

Sets trunk group ID manipulation that the Session Controller should perform on dialog-creating or out-of-dialog requests it receives on this adjacency. Unless this setting is configured, the Session Controller will pass through source trunk group IDs. For more information, see Trunk groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrunkGroups.html) and Configuring trunk group ID manipulation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTrunkGroupIDManipulation.html).

attribute perimeta::adjacency::sip_trunk_group_source_trunk_group_id_t? trunk_group_source_trunk_group_id=null

Specifies the trunk group ID that the Session Controller will add to incoming dialog-creating or out-of-dialog requests on this adjacency.

attribute perimeta::adjacency::sip_trunk_group_source_trunk_group_context_t? trunk_group_source_trunk_group_context=null

Specifies the trunk group ID context that the Session Controller will add to incoming dialog-creating or out-of-dialog requests on this adjacency.

attribute bool? refer_to_invite_transfer=null

Enables REFER to INVITE call transfer for this adjacency. REFER to INVITE call transfer allows the Session Controller to act as a SIP Transfer Agent in call transfer scenarios where the endpoint used by the initial caller does not support SIP REFERs, or where the policy of one of the networks involved in the call prevents the use of SIP REFERs. For more information, see REFER to INVITE call transfer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/REFERToINVITECallTransfer.html).

attribute bool? ms_teams_transfer=null

Enables Microsoft Teams call transfer for this adjacency. Microsoft Teams call transfers allow the Session Controller to act as a SIP Transfer Agent in REFER to INVITE and INVITE with REPLACES call transfer scenarios. For more information, see REFER to INVITE call transfer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/REFERToINVITECallTransfer.html).

attribute perimeta::adjacency::sip_p_charging_vector_t? p_charging_vector=null

Specifies the action that the Session Controller should take when handling SIP messages containing P-Charging-Vector headers on this adjacency. The P-Charging-Vector header is used in IMS networks to convey charging related information. By default, the Session Controller handles headers on SIP messages based on the type of adjacency. - On P-CSCF access, P-CSCF secure access, IBCF-external-untrusted and SRS adjacencies, it strips headers. - On P-CSCF core, E-CSCF - LRF, IMS core and eSRVCC functions - MSC adjacencies, it adds a header if there is not one already. - On other types of adjacency, it passes through existing headers. For more information on P-Charging Vector headers, see P-Charging-Vector support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PChargingVectorSupport.html).

attribute bool? p_charging_vector_use_default=null

Specifies the action that the Session Controller should take when handling SIP messages containing P-Charging-Vector headers on this adjacency. The P-Charging-Vector header is used in IMS networks to convey charging related information. By default, the Session Controller handles headers on SIP messages based on the type of adjacency. - On P-CSCF access, P-CSCF secure access, IBCF-external-untrusted and SRS adjacencies, it strips headers. - On P-CSCF core, E-CSCF - LRF, IMS core and eSRVCC functions - MSC adjacencies, it adds a header if there is not one already. - On other types of adjacency, it passes through existing headers. For more information on P-Charging Vector headers, see P-Charging-Vector support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PChargingVectorSupport.html).

attribute bool? ecn_trigger_on_call=null

Configures the Session Controller to send emergency call notifications for each emergency call processed on this adjacency. You must configure the Session Controller to trigger emergency call notifications on each access adjacency that might receive emergency calls. You must also use the target command to configure where the Session Controller sends emergency call notifications. Emergency call notifications make the TAS aware of an emergency call even if it is not included on the outbound path. This ensures that the TAS disables certain features that would prevent the emergency services from calling a caller back in the event of the call being dropped, such as call blocking and call redirect. For more information, see Configuring the Session Controller to send emergency call notifications to a TAS in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/notices.html).

attribute perimeta::adjacency::sip_ecn_target_t? ecn_target=null

Specifies whether the Session Controller will send emergency call notifications towards a single peer or a peer group. If you select peer, you must also specify the IP address (IPv4 or IPv6) or hostname of the peer using the ecn-target-peer Property. If you select peer-group, you must also specify the name of the peer group using the ecn-target-peer-group Property.

attribute perimeta::adjacency::sip_ecn_target_peer_t? ecn_target_peer=null

Specifies the IP address or FQDN of the peer to which notifications must be sent

attribute perimeta::adjacency::sip_ecn_target_port_t? ecn_target_port=null

Determines whether the Session Controller must send emergency call notifications to a specific port

attribute perimeta::adjacency::sip_ecn_target_port_value_t? ecn_target_port_value=null

Specifies the port to which notifications must be sent

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel account: Assigns this adjacency to an account, a group of adjacencies that can share some capacity control settings. For more information, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html). You cannot change this setting while the adjacency is active. :rel signaling_peer_group: Sets the signaling peer group for this adjacency. The Session Controller will send traffic to any one of the peers in the peer group. You cannot change this setting if the adjacency is active. You cannot set a value for this Property if you have already set a value for the signaling-peer Property. :rel remote_address_group: Specifies a group of remote IP addresses for SIP devices that can send traffic to this adjacency. The Session Controller uses remote IP address configuration to match incoming traffic to adjacencies. You must specify the name of an address group already configured on this Session Controller. For more information on address groups, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html). For more information on how the Session Controller selects an adjacency for inbound traffic, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html). :rel simple_routing_adjacency: Specifies the destination adjacency the Session Controller will use for simple routing. :rel msc_fallback_realm_group: The name of the fallback group containing the media realms to which calls on this adjacency will fall back if no optimal MSCs are available. :rel default_interop_profile: The name of the adjacency interoperability profile applied to this adjacency. Adjacency interoperability profiles allow you to use a given set of SIP signaling options across multiple adjacencies. :rel error_profile: Sets the SIP error profile to apply to this adjacency. These allow you to control which SIP error codes the Session Controller generates for particular internal errors; see Configuring SIP error profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPErrorProfiles.html) for more information. :rel lua_config_set: The Lua configuration set to use for messages on this adjacency. Lua configuration sets are a set of profiles created using the Lua scripting language to edit SDP passing through the Session Controller. :rel ecn_target_peer_group: Specifies the name of the peer group to which notifications must be sent

relation perimeta::account::AccountIdentity account [0:1]

Assigns this adjacency to an account, a group of adjacencies that can share some capacity control settings. For more

information, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html). You cannot change this setting while the adjacency is active.

Peer relation:

relation perimeta::peer_group_sip::PeerGroupSipIdentity signaling_peer_group [0:1]

Sets the signaling peer group for this adjacency. The Session Controller will send traffic to any one of the peers in

the peer group.

You cannot change this setting if the adjacency is active.

You cannot set a value for this Property if you have already set a value for the signaling-peer Property.

Peer relation:

relation perimeta::address_group::AddressGroupIdentity remote_address_group [0:1]

Specifies a group of remote IP addresses for SIP devices that can send traffic to this adjacency. The Session Controller

uses remote IP address configuration to match incoming traffic to adjacencies. You must specify the name of an address group already configured on this Session Controller.

For more information on address groups, see Address groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AddressGroups.html). For more information on how the Session Controller selects an adjacency for inbound traffic, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html).

Peer relation:

relation perimeta::adjacency::SipIdentity simple_routing_adjacency [0:1]

Specifies the destination adjacency the Session Controller will use for simple routing. Peer relation:

relation perimeta::media_realm_group::MediaRealmGroupIdentity msc_fallback_realm_group [0:1]

The name of the fallback group containing the media realms to which calls on this adjacency will fall back if no optimal

MSCs are available.

Peer relation:

relation perimeta::interop_profile::InteropProfileIdentity default_interop_profile [0:1]

The name of the adjacency interoperability profile applied to this adjacency. Adjacency interoperability profiles allow

you to use a given set of SIP signaling options across multiple adjacencies.

Peer relation:

relation perimeta::sip_message_manipulation::ErrorProfileIdentity error_profile [0:1]

Sets the SIP error profile to apply to this adjacency. These allow you to control which SIP error codes the Session

Controller generates for particular internal errors; see Configuring SIP error profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPErrorProfiles.html) for more information.

Peer relation:

relation perimeta::sip_message_manipulation::LuaConfigSetIdentity lua_config_set [0:1]

The Lua configuration set to use for messages on this adjacency. Lua configuration sets are a set of profiles created

using the Lua scripting language to edit SDP passing through the Session Controller.

Peer relation:

relation perimeta::peer_group_sip::PeerGroupSipIdentity ecn_target_peer_group [0:1]

Specifies the name of the peer group to which notifications must be sent Peer relation:

The following implementations are defined for this entity:

• perimeta::adjacency::sip_config

• perimeta::adjacency::sip_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_config, perimeta::adjacency::sip_cross_device_relations constraint true

entity perimeta::adjacency::SipAdjacencyLimits

Parents: perimeta::adjacency::SipAdjacencyLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/adjacency-limits Perimeta API resource.

Configuration mode for capacity control limits applying to this adjacency as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters; for more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_adjacency_limits_call_appearances_t? call_appearances=null

Specifies the maximum number of concurrent calls permitted for this adjacency. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute bool? call_appearances_use_default=null

Specifies the maximum number of concurrent calls permitted for this adjacency. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute perimeta::adjacency::sip_adjacency_limits_registrations_t? registrations=null

Sets the maximum number of concurrently registered subscribers for this adjacency.

attribute bool? registrations_use_default=null

Sets the maximum number of concurrently registered subscribers for this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_media_streams_t? media_streams=null

Sets a maximum number of concurrent media streams for this adjacency.

attribute bool? media_streams_use_default=null

Sets a maximum number of concurrent media streams for this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_t? call_setup_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which call setup messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_value_t? call_setup_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_sustain_units_t? call_setup_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_t? call_setup_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this adjacency.

attribute bool? call_setup_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_value_t? call_setup_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_call_setup_rate_max_burst_units_t? call_setup_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_t? in_call_message_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which in-call signaling messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_value_t? in_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_sustain_units_t? in_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_t? in_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this adjacency.

attribute bool? in_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_value_t? in_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_in_call_message_rate_max_burst_units_t? in_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_t? out_of_call_message_rate_max_sustain=null

Sets a maximum sustained rate at which out-of-call signaling messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_value_t? out_of_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_sustain_units_t? out_of_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_t? out_of_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which out-of-call signaling messages can be sent to or from this adjacency.

attribute bool? out_of_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which out-of-call signaling messages can be sent to or from this adjacency.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_value_t? out_of_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_out_of_call_message_rate_max_burst_units_t? out_of_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_t? regs_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate of registrations (including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_value_t? regs_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_sustain_units_t? regs_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_t? regs_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute bool? regs_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_value_t? regs_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_adjacency_limits_regs_rate_max_burst_units_t? regs_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_adjacency_limits_max_bandwidth_t? max_bandwidth=null

Sets a maximum for the amount of bandwidth used by this adjacency at any one time.

attribute bool? max_bandwidth_use_default=null

Sets a maximum for the amount of bandwidth used by this adjacency at any one time.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_adjacency_limits_config

• perimeta::adjacency::sip_adjacency_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_adjacency_limits_config, perimeta::adjacency::sip_adjacency_limits_cross_device_relations constraint true

entity perimeta::adjacency::SipAdjacencyLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/adjacency-limits Perimeta API resource. Abstract base entity. For concrete usage, see children SipAdjacencyLimits and SipAdjacencyLimitsUnmanaged.

Configuration mode for capacity control limits applying to this adjacency as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters; for more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

attribute perimeta::adjacency::sip_adjacency_limits_direction_t direction

Specifies the direction in which capacity control limits must be applied.

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.adjacency_limits [0:*]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_adjacency_limits_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_adjacency_limits_uri constraint true

entity perimeta::adjacency::SipAdjacencyLimitsUnmanaged

Parents: perimeta::adjacency::SipAdjacencyLimitsIdentity

Unmanaged reference to a /adjacency/sip/adjacency-limits Perimeta API resource.

Configuration mode for capacity control limits applying to this adjacency as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters; for more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipCallLimits

Parents: perimeta::adjacency::SipCallLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this adjacency. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_call_limits_max_media_renegotiations_t? max_media_renegotiations=null

Sets a maximum number of media renegotiations per call for this adjacency.

attribute bool? max_media_renegotiations_use_default=null

Sets a maximum number of media renegotiations per call for this adjacency.

attribute perimeta::adjacency::sip_call_limits_media_streams_t? media_streams=null

Sets a maximum number of media streams per call for this adjacency.

attribute bool? media_streams_use_default=null

Sets a maximum number of media streams per call for this adjacency.

attribute perimeta::adjacency::sip_call_limits_max_call_duration_t? max_call_duration=null

Set the maximum duration in seconds for a call on this adjacency.

attribute bool? max_call_duration_use_default=null

Set the maximum duration in seconds for a call on this adjacency.

attribute perimeta::adjacency::sip_call_limits_max_bandwidth_t? max_bandwidth=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this adjacency. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? max_bandwidth_use_default=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this adjacency. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_call_limits_config

• perimeta::adjacency::sip_call_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_call_limits_config, perimeta::adjacency::sip_call_limits_cross_device_relations constraint true

entity perimeta::adjacency::SipCallLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/call-limits Perimeta API resource. Abstract base entity. For concrete usage, see children SipCallLimits and SipCallLimitsUnmanaged.

Configuration mode for capacity control limits applying to individual calls involving this adjacency. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.call_limits [0:1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_call_limits_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_call_limits_uri constraint true

entity perimeta::adjacency::SipCallLimitsUnmanaged

Parents: perimeta::adjacency::SipCallLimitsIdentity

Unmanaged reference to a /adjacency/sip/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this adjacency. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipCallMediaPolicy

Parents: perimeta::adjacency::SipCallMediaPolicyIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls through this adjacency. These settings control a variety of features of calls. For more information see Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? generic_stream_list_use_default=null

Specifies the generic stream list the Session Controller must use for this adjacency’s call media policy. Generic streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using this call media policy. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html).

attribute perimeta::adjacency::sip_call_media_policy_media_address_type_t? media_address_type=null

Sets whether the Session Controller should use IPv4, IPv6, or both for media on this adjacency. For more information, see IPv4 and IPv6 media policing and interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/IPv4AndIPv6MediaPolicingAndInterworking.html). By default (if no configured policy applies), the Session Controller uses the caller adjacency address type.

attribute bool? media_address_type_use_default=null

Sets whether the Session Controller should use IPv4, IPv6, or both for media on this adjacency. For more information, see IPv4 and IPv6 media policing and interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/IPv4AndIPv6MediaPolicingAndInterworking.html). By default (if no configured policy applies), the Session Controller uses the caller adjacency address type.

attribute bool? media_address_preserve=null

Configures the Session Controller to preserve the media gates for any media streams that an endpoint disables mid-call. This allows the streams to be reinstated using the same addresses and ports. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

attribute perimeta::adjacency::sip_call_media_policy_ice_lite_t? ice_lite=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this adjacency. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute bool? ice_lite_use_default=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this adjacency. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute perimeta::adjacency::sip_call_media_policy_media_bypass_policy_t? media_bypass_policy=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls on this adjacency. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute bool? media_bypass_policy_use_default=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls on this adjacency. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute perimeta::adjacency::sip_call_media_policy_active_call_bypass_t? active_call_bypass=null

Determines whether the Session Controller permits media bypass for active calls on this adjacency, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls on adjacencies that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls on adjacencies that are used to connect to the endpoints in calls.

attribute bool? active_call_bypass_use_default=null

Determines whether the Session Controller permits media bypass for active calls on this adjacency, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls on adjacencies that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls on adjacencies that are used to connect to the endpoints in calls.

attribute bool? supported_codecs_use_default=null

Sets a codec allowlist to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? preferred_codecs_use_default=null

Sets a codec preference list to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? non_audio_video_codecs_use_default=null

Sets a codec allowlist for non audio/video media streams to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? preferred_payload_types_use_default=null

Sets the RTP payload type preference list to use on this adjacency. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on this adjacency.

attribute perimeta::adjacency::sip_call_media_policy_comfort_noise_codec_t? comfort_noise_codec=null

Specifies whether the Session Controller should perform comfort noise interworking for calls on this adjacency. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? comfort_noise_codec_use_default=null

Specifies whether the Session Controller should perform comfort noise interworking for calls on this adjacency. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? transcoding=null

Enables transcoding calls on this adjacency. The Session Controller performs transcoding to interwork between different media codecs on the two legs of a call, allowing support for calls between devices that do not share supported codecs. See Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html) for more information.

attribute perimeta::adjacency::sip_call_media_policy_transcoding_trigger_t? transcoding_trigger=null

Sets the transcoding trigger for this adjacency, which controls when calls enter transcoding mode. Transcoding mode means Perimeta will add codecs that require transcoding to SDP offers; it does not always mean the call will necessarily use transcoding, since endpoints can select a non-transcoding codec. For more details see Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? answer_generation_match_fidelity=null

Specifies that the Session Controller should choose a codec for its answer to the inbound offer that causes the same fidelity (standard definition (SD) or high definition (HD)) to be used on each side of the call when transcoding and using this adjacency. This is only possible if the inbound offer contained both SD and HD codecs. You must set this on the caller’s side of the call. If the caller offers both SD and HD codecs, you can use this to prevent SD-to-HD or HD-to-SD transcoding. These combinations use more resources than SD-to-SD transcoding and provide worse call quality than HD-to-HD transcoding. For more background information, see Matching codec fidelities in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? tty_interwork_from_rfc4103=null

Specifies whether the Session Controller should interwork between RFC 4103 Real-Time Text (RTT) and Text Telephone (TTY). The Session Controller always initially passes through an RTT offer. If this configuration is set, the Session Controller initiates interworking after receiving either a 200 with a disabled text media stream or no text media stream present, a 415, or a 488 response to an RTT offer. This feature is only available on systems with software transcoding enabled. For more information on configuring Perimeta to interwork from RTT to TTY, see RTT and TTY interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTTAndTTYInterworking.html).

attribute perimeta::adjacency::sip_call_media_policy_fax_transcoding_t? fax_transcoding=null

Enables fax transcoding on this adjacency and specifies the fax transport protocol for the Session Controller to use for this adjacency. If you select T.38, the Session Controller will use T.38 for fax calls if possible, but will use G.711 if T.38 is not available. If you select G.711, the Session Controller will never use T.38 for fax calls on this adjacency. For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::adjacency::sip_call_media_policy_fax_transcoding_default_pcm_type_t? fax_transcoding_default_pcm_type=null

Specifies the PCM variant that the Session Controller must use when generating a fax transcoding offer.

attribute perimeta::adjacency::sip_call_media_policy_fax_transcoding_jitter_buffer_size_t? fax_transcoding_jitter_buffer_size=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute bool? fax_transcoding_jitter_buffer_size_use_default=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute perimeta::adjacency::sip_call_media_policy_fax_transcoding_generate_reinvite_t? fax_transcoding_generate_reinvite=null

Specifies whether the Session Controller should detect fax tones on G.711 calls made through this adjacency and generate T.38 reINVITEs when required. If you set this Property to enabled, the Session Controller will generate a T.38 reINVITE on detection of a V.21 flag from the receiving fax machine or gateway. If you set this Property to on-cng, the Session Controller will generate a T.38 reINVITE on detection of a CNG tone from either side of the fax call.

attribute bool? fax_transcoding_retry_on_4xx=null

Specifies that the Session Controller should invoke fax transcoding and use G.711 on this adjacency’s leg of the call if it receives a 4xx response to an original T.38 offer. You must only set this Property to true if the Session Controller is configured to use T.38 for fax transcoding on this adjacency.

attribute perimeta::adjacency::sip_call_media_policy_fax_transcoding_tone_detection_mode_t? fax_transcoding_tone_detection_mode=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute bool? fax_transcoding_tone_detection_mode_use_default=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::adjacency::sip_call_media_policy_inband_tones_t? inband_tones=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints on this account. Perimeta will only perform inband DTMF interworking on calls into adjacencies with ‘inband-tone-interworking’ set if this command is set to ‘present’ on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tones_use_default=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints on this account. Perimeta will only perform inband DTMF interworking on calls into adjacencies with ‘inband-tone-interworking’ set if this command is set to ‘present’ on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute perimeta::adjacency::sip_call_media_policy_inband_tone_interworking_t? inband_tone_interworking=null

Enables or disables inband DTMF interworking for calls going into this adjacency; either when transcoding away from G.711 (‘on-transcode’) or for all calls. Only applies if ‘inband-tones present’ is set on the adjacency on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tone_interworking_use_default=null

Enables or disables inband DTMF interworking for calls going into this adjacency; either when transcoding away from G.711 (‘on-transcode’) or for all calls. Only applies if ‘inband-tones present’ is set on the adjacency on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? repeat_sdp_on_18x=null

Configures the Session Controller to add a repeat of the agreed SDP to provisional “18x” responses after the initial successful INVITE offer-answer exchange for calls made from this adjacency. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute bool? repeat_sdp_on_200ok=null

Configures the Session Controller to add a repeat of the agreed SDP to the 200 OK response for calls made from this adjacency. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute perimeta::adjacency::sip_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t? session_refresh_sdp_renegotiation_on_pass_through=null

Configures whether the Session Controller supports SDP renegotiation if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect a device to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation on an adjacency that will handle calls using paired media bypass. If you set this command to ‘inherit’, the adjacency will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute bool? session_refresh_sdp_renegotiation_on_pass_through_use_default=null

Configures whether the Session Controller supports SDP renegotiation if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect a device to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation on an adjacency that will handle calls using paired media bypass. If you set this command to ‘inherit’, the adjacency will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute perimeta::adjacency::sip_call_media_policy_hold_indicator_t? hold_indicator=null

Sets the method or combination of methods that the Session Controller should use when signaling call hold to endpoints in this adjacency. The default (when no configured policy applies) is standard. For more information, see Call hold interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallHoldInterworking.html).

attribute bool? ignore_sdp_bandwidth_fields=null

Configures the Session Controller to ignore ‘b=’ lines in SDP and to calculate bandwidth requirements for a call based on the codecs used. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::adjacency::sip_call_media_policy_secure_media_t? secure_media=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this account. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? secure_media_use_default=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this account. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute perimeta::adjacency::sip_call_media_policy_srtp_mki_t? srtp_mki=null

Secure media MKI policy (SRTP)

attribute bool? srtp_mki_use_default=null

Secure media MKI policy (SRTP)

attribute bool? strip_all_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all disabled media descriptions from SDP offers on this adjacency.

attribute bool? strip_new_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all new disabled media descriptions from SDP offers on this adjacency. New streams are those that are unknown to the recipient. All streams in an initial offer are new, as are any streams added to a reoffer.

attribute bool? strip_disabled_media_descriptions_from_answers=null

Specifies whether the Session Controller will strip all disabled media descriptions from forwarded answers on this adjacency. Note that setting this Property to true violates RFC 3264.

attribute bool? disabled_media_descriptions_pad_offers=null

Specifies whether the Session Controller will pad reoffers on this adjacency with dummy media lines to replace lines removed by the sender.

attribute perimeta::adjacency::sip_call_media_policy_early_media_timeout_t? early_media_timeout=null

Sets a maximum length of time for which early media is allowed. If the call is not connected within this time period, it will be torn down.

attribute bool? early_media_timeout_use_default=null

Sets a maximum length of time for which early media is allowed. If the call is not connected within this time period, it will be torn down.

attribute perimeta::adjacency::sip_call_media_policy_early_media_p_early_media_t? early_media_p_early_media=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this adjacency.

attribute bool? early_media_p_early_media_use_default=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this adjacency.

attribute perimeta::adjacency::sip_call_media_policy_bandwidth_policing_mode_t? bandwidth_policing_mode=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? bandwidth_policing_mode_use_default=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::adjacency::sip_call_media_policy_force_ptime_t? force_ptime=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute bool? force_ptime_use_default=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute perimeta::adjacency::sip_call_media_policy_force_ptime_value_t? force_ptime_value=null

Specifies the packetization time (in milliseconds) to be used on this side of the call.

attribute perimeta::adjacency::sip_call_media_policy_rtcp_suppression_t? rtcp_suppression=null

Specifies how the Session Controller should handle RTCP packets for calls using this adjacency. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute bool? rtcp_suppression_use_default=null

Specifies how the Session Controller should handle RTCP packets for calls using this adjacency. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute perimeta::adjacency::sip_call_media_policy_rtcp_multiplexing_t? rtcp_multiplexing=null

Enables RTP/RTCP multiplexing on calls using this adjacency. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute bool? rtcp_multiplexing_use_default=null

Enables RTP/RTCP multiplexing on calls using this adjacency. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute perimeta::adjacency::sip_call_media_policy_rtcp_xr_block_types_t? rtcp_xr_block_types=null

Specifies any requested RTCP-XR block types on this adjacency

attribute perimeta::adjacency::sip_call_media_policy_media_latching_t? media_latching=null

Specifies whether media latching should be disabled for traffic on this adjacency. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute bool? media_latching_use_default=null

Specifies whether media latching should be disabled for traffic on this adjacency. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_t? all_calls_jitter_buffer=null

Controls whether a jitter buffer is enabled for all calls on this adjacency. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute bool? all_calls_jitter_buffer_use_default=null

Controls whether a jitter buffer is enabled for all calls on this adjacency. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_size_t? all_calls_jitter_buffer_size=null

Set the fixed size (Fixed Mode) or initial size (Adaptive mode) for the jitter buffer in milliseconds

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_max_size_t? all_calls_jitter_buffer_max_size=null

Specifies the maximum capacity of the all calls jitter buffer.

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_min_size_t? all_calls_jitter_buffer_min_size=null

Specifies the minimum capacity of the all calls jitter buffer.

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_step_size_t? all_calls_jitter_buffer_step_size=null

Specifies the size by which the capacity of the all calls jitter buffer should change in response to packet delay variation.

attribute perimeta::adjacency::sip_call_media_policy_all_calls_jitter_buffer_step_rate_t? all_calls_jitter_buffer_step_rate=null

Specifies how frequently the capacity of the all calls jitter buffer should change. This is expressed as a percentage of the size of the buffer.

attribute perimeta::adjacency::sip_call_media_policy_media_capture_percentage_t? media_capture_percentage=null

Configures the probability that the media for an individual call on this adjacency is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute bool? media_capture_percentage_use_default=null

Configures the probability that the media for an individual call on this adjacency is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute perimeta::adjacency::sip_call_media_policy_media_timeout_t? media_timeout=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute bool? media_timeout_use_default=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute perimeta::adjacency::sip_call_media_policy_remove_csrc_t? remove_csrc=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool? remove_csrc_use_default=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel generic_stream_list: Specifies the generic stream list the Session Controller must use for this adjacency’s call media policy. Generic streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using this call media policy. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html). :rel supported_codecs: Sets a codec allowlist to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel preferred_codecs: Sets a codec preference list to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel non_audio_video_codecs: Sets a codec allowlist for non audio/video media streams to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel preferred_payload_types: Sets the RTP payload type preference list to use on this adjacency. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on this adjacency. :rel offer_generation_codec_template: Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers. :rel qos_sig_profile: Sets a Quality of Service profile to apply to signaling packets routed into this adjacency. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_video_profile: Sets a Quality of Service profile to apply to video media packets routed into this adjacency. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_voice_profile: Sets a Quality of Service profile to apply to voice media packets routed into this adjacency. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_msrp_profile: Sets a Quality of Service profile to apply to MSRP media packets routed into this adjacency. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

relation perimeta::sip_generic_stream_list::SipGenericStreamListIdentity generic_stream_list [0:1]

Specifies the generic stream list the Session Controller must use for this adjacency’s call media policy. Generic

streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using this call media policy. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity supported_codecs [0:1]

Sets a codec allowlist to use with this adjacency. For more information, see Codec lists in Perimeta Configuration and

Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_codecs [0:1]

Sets a codec preference list to use with this adjacency. For more information, see Codec lists in Perimeta Configuration

and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity non_audio_video_codecs [0:1]

Sets a codec allowlist for non audio/video media streams to use with this adjacency. For more information, see Codec

lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_payload_types [0:1]

Sets the RTP payload type preference list to use on this adjacency. An RTP payload type preference list allows you to

control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints on this adjacency.

Peer relation:

relation perimeta::codec_list::CodecListIdentity offer_generation_codec_template [0:1]

Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers. If you do not use

this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers.

Peer relation:

relation perimeta::qos::SigIdentity qos_sig_profile [0:1]

Sets a Quality of Service profile to apply to signaling packets routed into this adjacency. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VideoIdentity qos_video_profile [0:1]

Sets a Quality of Service profile to apply to video media packets routed into this adjacency. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VoiceIdentity qos_voice_profile [0:1]

Sets a Quality of Service profile to apply to voice media packets routed into this adjacency. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::MsrpIdentity qos_msrp_profile [0:1]

Sets a Quality of Service profile to apply to MSRP media packets routed into this adjacency. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::adjacency::sip_call_media_policy_config

• perimeta::adjacency::sip_call_media_policy_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_call_media_policy_config, perimeta::adjacency::sip_call_media_policy_cross_device_relations constraint true

entity perimeta::adjacency::SipCallMediaPolicyIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/call-media-policy Perimeta API resource. Abstract base entity. For concrete usage, see children SipCallMediaPolicy and SipCallMediaPolicyUnmanaged.

Configuration mode for call media policies affecting calls through this adjacency. These settings control a variety of features of calls. For more information see Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html).

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.call_media_policy [0:1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_call_media_policy_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_call_media_policy_uri constraint true

entity perimeta::adjacency::SipCallMediaPolicyUnmanaged

Parents: perimeta::adjacency::SipCallMediaPolicyIdentity

Unmanaged reference to a /adjacency/sip/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls through this adjacency. These settings control a variety of features of calls. For more information see Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipDelegateAuthentication

Parents: perimeta::adjacency::SipDelegateAuthenticationIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/delegate-authentication Perimeta API resource.

Creates and configures a Delegate Authentication Resource for an authentication realm. An authentication realm corresponds to a protection domain for which the Session Controller must perform delegated registration and defines the credentials it should use when generating authentication responses on behalf of a remote device. For more information, see SIP Authentication Support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPAuthenticationSupport.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_delegate_authentication_username_t username

Sets the username associated with this realm.

attribute perimeta::adjacency::sip_delegate_authentication_hashed_password_t hashed_password

Sets the password hash (as a 32 character hex string) associated with this realm.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_delegate_authentication_config

• perimeta::adjacency::sip_delegate_authentication_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_delegate_authentication_config, perimeta::adjacency::sip_delegate_authentication_cross_device_relations constraint true

entity perimeta::adjacency::SipDelegateAuthenticationIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/delegate-authentication Perimeta API resource. Abstract base entity. For concrete usage, see children SipDelegateAuthentication and SipDelegateAuthenticationUnmanaged.

Creates and configures a Delegate Authentication Resource for an authentication realm. An authentication realm corresponds to a protection domain for which the Session Controller must perform delegated registration and defines the credentials it should use when generating authentication responses on behalf of a remote device. For more information, see SIP Authentication Support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPAuthenticationSupport.html).

attribute perimeta::adjacency::sip_delegate_authentication_authentication_realm_t authentication_realm

Realm name

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.delegate_authentication [0:*]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_delegate_authentication_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_delegate_authentication_uri constraint true

entity perimeta::adjacency::SipDelegateAuthenticationUnmanaged

Parents: perimeta::adjacency::SipDelegateAuthenticationIdentity

Unmanaged reference to a /adjacency/sip/delegate-authentication Perimeta API resource.

Creates and configures a Delegate Authentication Resource for an authentication realm. An authentication realm corresponds to a protection domain for which the Session Controller must perform delegated registration and defines the credentials it should use when generating authentication responses on behalf of a remote device. For more information, see SIP Authentication Support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPAuthenticationSupport.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip Perimeta API resource. Abstract base entity. For concrete usage, see children Sip and SipUnmanaged.

Configuration mode for a SIP adjacency (a SIP interface used by the Session Controller on a particular service network). For more information, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html).

attribute perimeta::adjacency::sip_adjacency_name_t adjacency_name

Specifies a name for this SIP adjacency.

relation perimeta::adjacency::SipDelegateAuthenticationIdentity delegate_authentication [0:*]

other end: perimeta::adjacency::SipDelegateAuthenticationIdentity.sip [1]

relation perimeta::adjacency::SipAdjacencyLimitsIdentity adjacency_limits [0:*]

other end: perimeta::adjacency::SipAdjacencyLimitsIdentity.sip [1]

relation perimeta::adjacency::SipTrafficGroupIdentity traffic_group [0:*]

other end: perimeta::adjacency::SipTrafficGroupIdentity.sip [1]

relation perimeta::adjacency::SipCallMediaPolicyIdentity call_media_policy [0:1]

other end: perimeta::adjacency::SipCallMediaPolicyIdentity.sip [1]

relation perimeta::adjacency::SipCallLimitsIdentity call_limits [0:1]

other end: perimeta::adjacency::SipCallLimitsIdentity.sip [1]

relation perimeta::adjacency::SipInteropIdentity interop [0:1]

other end: perimeta::adjacency::SipInteropIdentity.sip [1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_uri constraint true

entity perimeta::adjacency::SipInterop

Parents: perimeta::adjacency::SipInteropIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/interop Perimeta API resource.

Configuration mode that includes commands relating to SIP device interoperability options. These commands are all available through adjacency interoperability profiles - commands configured in this mode will override any interoperability profile applied to the adjacency.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_interop_dynamic_ims_aka_t? dynamic_ims_aka=null

Enabling this feature allows this P-CSCF secure access adjacency to accept SIP traffic from non-IMS-AKA endpoints. For more information, see Configuring dynamic IMS AKA detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringDynamicIMSAKA.html).

attribute bool? dynamic_ims_aka_use_default=null

Enabling this feature allows this P-CSCF secure access adjacency to accept SIP traffic from non-IMS-AKA endpoints. For more information, see Configuring dynamic IMS AKA detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringDynamicIMSAKA.html).

attribute perimeta::adjacency::sip_interop_message_verification_t? message_verification=null

Specifies whether SIP request verification is enabled on this adjacency. When it is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the specified verification service. If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header. To enable this, you must use the header-settings verstat property at the global default, interoperability profile or adjacency scope. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? message_verification_use_default=null

Specifies whether SIP request verification is enabled on this adjacency. When it is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the specified verification service. If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header. To enable this, you must use the header-settings verstat property at the global default, interoperability profile or adjacency scope. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::adjacency::sip_interop_preferred_transport_t? preferred_transport=null

Sets a preferred transport protocol to use for connections to endpoints in this adjacency. If this setting is not configured, the Session Controller will use standard SIP transport selection. For more information, see Configuring a mandated or preferred transport protocol for outbound SIP traffic in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPreferredTransportProtocolForOutboundSIPTraffic.html).

attribute bool? preferred_transport_use_default=null

Sets a preferred transport protocol to use for connections to endpoints in this adjacency. If this setting is not configured, the Session Controller will use standard SIP transport selection. For more information, see Configuring a mandated or preferred transport protocol for outbound SIP traffic in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPreferredTransportProtocolForOutboundSIPTraffic.html).

attribute perimeta::adjacency::sip_interop_dynamic_peer_routing_t? dynamic_peer_routing=null

Enables dynamic domain routing to this adjacency. With this enabled, dynamic-peer-routing entries in destination domain routing tables will route to this adjacency if the destination domain of the SIP message matches the configured dynamic routing match domain, or the signaling peer (or peer group hostname) if no match domain is configured. See Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html) for more information.

attribute bool? dynamic_peer_routing_use_default=null

Enables dynamic domain routing to this adjacency. With this enabled, dynamic-peer-routing entries in destination domain routing tables will route to this adjacency if the destination domain of the SIP message matches the configured dynamic routing match domain, or the signaling peer (or peer group hostname) if no match domain is configured. See Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html) for more information.

attribute perimeta::adjacency::sip_interop_dialog_transparency_t? dialog_transparency=null

Configures SIP dialog transparency on this adjacency. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute bool? dialog_transparency_use_default=null

Configures SIP dialog transparency on this adjacency. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute perimeta::adjacency::sip_interop_message_signing_t? message_signing=null

Specifies whether SIP request signing is enabled on this adjacency. This overrides any global SIP request signing configuration or configuration on an interoperability profile. When it is enabled, the Session Controller sends signing requests for all outbound INVITEs on this adjaceny that meet the following conditions to the specified signing service. - The INVITE does not already have an Identity header, and is therefore unsigned. - The call has an Attestation-Indicator header or a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number. - The call has an Origination-Id header or a P-Origination-Id header. This specifies the originator of the signing request. If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE. Perimeta Session Controllers can add the P-Attestation-Indicator and P-Origination-Id headers to calls before forwarding them into your core network. To configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? message_signing_use_default=null

Specifies whether SIP request signing is enabled on this adjacency. This overrides any global SIP request signing configuration or configuration on an interoperability profile. When it is enabled, the Session Controller sends signing requests for all outbound INVITEs on this adjaceny that meet the following conditions to the specified signing service. - The INVITE does not already have an Identity header, and is therefore unsigned. - The call has an Attestation-Indicator header or a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number. - The call has an Origination-Id header or a P-Origination-Id header. This specifies the originator of the signing request. If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE. Perimeta Session Controllers can add the P-Attestation-Indicator and P-Origination-Id headers to calls before forwarding them into your core network. To configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::adjacency::sip_interop_reinvite_without_sdp_t? reinvite_without_sdp=null

Configure how the Perimeta deals with reINVITEs with no SDP sent out of this adjacency.

attribute bool? reinvite_without_sdp_use_default=null

Configure how the Perimeta deals with reINVITEs with no SDP sent out of this adjacency.

attribute perimeta::adjacency::sip_interop_distribute_expiry_t? distribute_expiry=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute bool? distribute_expiry_use_default=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute perimeta::adjacency::sip_interop_priority_statistics_groups_t? priority_statistics_groups=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this adjacency.

attribute bool? priority_statistics_groups_use_default=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this adjacency.

attribute perimeta::adjacency::sip_interop_skip_peer_retry_on_503_t? skip_peer_retry_on_503=null

Specifies whether the Session Controller will skip retrying an alternative peer after receiving a 503 response, or attempt a retry if the limit set by dns-hunting-limit has not been reached. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute bool? skip_peer_retry_on_503_use_default=null

Specifies whether the Session Controller will skip retrying an alternative peer after receiving a 503 response, or attempt a retry if the limit set by dns-hunting-limit has not been reached. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute perimeta::adjacency::sip_interop_retry_on_additional_sip_errors_t? retry_on_additional_sip_errors=null

Specifies up to ten additional SIP error codes which trigger a request to be retried to a different peer, unless the limit set by dns-hunting-limit has been reached. By default, only a 503 response triggers a retry. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. We recommend that you only set this on adjacencies that use a peer group. If you set this on an adjacency that uses a static DNS signaling peer, the additional responses will count as 503s and may cause the peer to be marked as unavailable. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute bool? retry_on_additional_sip_errors_use_default=null

Specifies up to ten additional SIP error codes which trigger a request to be retried to a different peer, unless the limit set by dns-hunting-limit has been reached. By default, only a 503 response triggers a retry. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. We recommend that you only set this on adjacencies that use a peer group. If you set this on an adjacency that uses a static DNS signaling peer, the additional responses will count as 503s and may cause the peer to be marked as unavailable. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute perimeta::adjacency::sip_interop_retry_on_additional_sip_errors_value_t? retry_on_additional_sip_errors_value=null

Quoted, space-separated string of SIP error codes (only 4xx, 5xx and 6xx).

attribute perimeta::adjacency::sip_interop_call_handling_incomplete_information_t? call_handling_incomplete_information=null

Specifies the action to take if the Session Controller cannot try to verify the call because some of the information required to construct a verification request is missing.

attribute bool? call_handling_incomplete_information_use_default=null

Specifies the action to take if the Session Controller cannot try to verify the call because some of the information required to construct a verification request is missing.

attribute perimeta::adjacency::sip_interop_call_handling_verification_failure_t? call_handling_verification_failure=null

Specifies the action to take if a verification request fails because the verification service does not respond with a value of “TN-Validation-Passed”. This can happen if the verification service cannot be contacted, responds with a 200 OK with a value other than “TN-Validation-Passed” or responds with an error. Note that if the connection to the verification service fails and you decide to reject calls when a verification request fails, your Session Controller will reject all calls that must either be verified successfully or rejected.

attribute bool? call_handling_verification_failure_use_default=null

Specifies the action to take if a verification request fails because the verification service does not respond with a value of “TN-Validation-Passed”. This can happen if the verification service cannot be contacted, responds with a 200 OK with a value other than “TN-Validation-Passed” or responds with an error. Note that if the connection to the verification service fails and you decide to reject calls when a verification request fails, your Session Controller will reject all calls that must either be verified successfully or rejected.

attribute perimeta::adjacency::sip_interop_verification_standard_t? verification_standard=null

Sets the STIR/SHAKEN standard to use when verifying SIP messages on this adjacency. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? verification_standard_use_default=null

Sets the STIR/SHAKEN standard to use when verifying SIP messages on this adjacency. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::adjacency::sip_interop_signing_standard_t? signing_standard=null

Sets the STIR/SHAKEN standard to use when signing SIP messages on this adjacency. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? signing_standard_use_default=null

Sets the STIR/SHAKEN standard to use when signing SIP messages on this adjacency. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::adjacency::sip_interop_emergency_calling_elin_support_t? emergency_calling_elin_support=null

Specifies whether Perimeta should search for and parse PIDF-LO message bodies in SIP INVITES for ELIN and subsequently update the P-Asserted-Identity header with this information on responses to those INVITEs received on this adjacency.

attribute bool? emergency_calling_elin_support_use_default=null

Specifies whether Perimeta should search for and parse PIDF-LO message bodies in SIP INVITES for ELIN and subsequently update the P-Asserted-Identity header with this information on responses to those INVITEs received on this adjacency.

attribute perimeta::adjacency::sip_interop_header_settings_rewrite_from_header_t? header_settings_rewrite_from_header=null

Specifies whether the Session Controller will rewrite the From header in outgoing SIP messages on adjacencies using this interoperability profile.

attribute bool? header_settings_rewrite_from_header_use_default=null

Specifies whether the Session Controller will rewrite the From header in outgoing SIP messages on adjacencies using this interoperability profile.

attribute perimeta::adjacency::sip_interop_header_settings_from_header_host_source_t? header_settings_from_header_host_source=null

Specifies the source the Session Controller must use to replace the host section of the From header.

attribute bool? header_settings_from_header_host_source_use_default=null

Specifies the source the Session Controller must use to replace the host section of the From header.

attribute perimeta::adjacency::sip_interop_header_settings_include_port_in_from_header_t? header_settings_include_port_in_from_header=null

Specifies whether the Session Controller will include a port number in the rewritten URI.

attribute bool? header_settings_include_port_in_from_header_use_default=null

Specifies whether the Session Controller will include a port number in the rewritten URI.

attribute perimeta::adjacency::sip_interop_header_settings_rewrite_to_header_t? header_settings_rewrite_to_header=null

Specifies whether the Session Controller must rewrite the To header in dialog-creating or out-of-dialog SIP requests (other than REGISTERs) on this adjacency.

attribute bool? header_settings_rewrite_to_header_use_default=null

Specifies whether the Session Controller must rewrite the To header in dialog-creating or out-of-dialog SIP requests (other than REGISTERs) on this adjacency.

attribute perimeta::adjacency::sip_interop_header_settings_inbound_via_handling_t? header_settings_inbound_via_handling=null

Specifies whether the Session Controller must pass through or strip Via headers on all inbound requests received by this adjacency.

attribute bool? header_settings_inbound_via_handling_use_default=null

Specifies whether the Session Controller must pass through or strip Via headers on all inbound requests received by this adjacency.

attribute perimeta::adjacency::sip_interop_header_settings_outbound_via_handling_t? header_settings_outbound_via_handling=null

Specifies whether the Session Controller must pass through or strip Via headers on all outbound requests received by this adjacency.

attribute bool? header_settings_outbound_via_handling_use_default=null

Specifies whether the Session Controller must pass through or strip Via headers on all outbound requests received by this adjacency.

attribute perimeta::adjacency::sip_interop_header_settings_suppress_expires_header_t? header_settings_suppress_expires_header=null

Specifies whether the Session Controller must remove the Expires header from SIP INVITE requests received by this adjacency.

attribute bool? header_settings_suppress_expires_header_use_default=null

Specifies whether the Session Controller must remove the Expires header from SIP INVITE requests received by this adjacency.

attribute perimeta::adjacency::sip_interop_header_settings_respect_id_priority_t? header_settings_respect_id_priority=null

Specifies whether to use dialed numbers and usernames in INVITEs received on this adjacency to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_id_priority_use_default=null

Specifies whether to use dialed numbers and usernames in INVITEs received on this adjacency to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::adjacency::sip_interop_header_settings_respect_resource_priority_t? header_settings_respect_resource_priority=null

Specifies whether to use Resource Priority headers received on this adjacency to apply priority categories to a call. By default, the Session Controller only uses a Resource Priority header to apply priority categories if the header is received on a core adjacency. For a list of core adjacency types, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_resource_priority_use_default=null

Specifies whether to use Resource Priority headers received on this adjacency to apply priority categories to a call. By default, the Session Controller only uses a Resource Priority header to apply priority categories if the header is received on a core adjacency. For a list of core adjacency types, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::adjacency::sip_interop_header_settings_respect_priority_t? header_settings_respect_priority=null

Specifies whether to use Priority headers received on this adjacency to apply priority categories to a call. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_priority_use_default=null

Specifies whether to use Priority headers received on this adjacency to apply priority categories to a call. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::adjacency::sip_interop_header_settings_contact_header_add_tls_t? header_settings_contact_header_add_tls=null

Specifies whether the Session Controller must add the transport=tls parameter to the Contact or Record-Route headers of SIP messages sent over this adjacency. This indicates to endpoints that they must use TLS, but might not be supported by some devices.

attribute bool? header_settings_contact_header_add_tls_use_default=null

Specifies whether the Session Controller must add the transport=tls parameter to the Contact or Record-Route headers of SIP messages sent over this adjacency. This indicates to endpoints that they must use TLS, but might not be supported by some devices.

attribute perimeta::adjacency::sip_interop_header_settings_refer_to_uri_t? header_settings_refer_to_uri=null

Specifies the value the Session Controller must use when rewriting the URI in a Refer-To header for requests sent out over this adjacency. The Session Controller rewrites the URI in a Refer-To header as part of supporting Basic and Advanced call transfers. For detailed information on the circumstances in which the Session Controller will rewrite the URI in Refer-To headers, see SIP call transfer passthrough on the Session Controller in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPCallTransferPassthrough.html).

attribute bool? header_settings_refer_to_uri_use_default=null

Specifies the value the Session Controller must use when rewriting the URI in a Refer-To header for requests sent out over this adjacency. The Session Controller rewrites the URI in a Refer-To header as part of supporting Basic and Advanced call transfers. For detailed information on the circumstances in which the Session Controller will rewrite the URI in Refer-To headers, see SIP call transfer passthrough on the Session Controller in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPCallTransferPassthrough.html).

attribute perimeta::adjacency::sip_interop_header_settings_p_asserted_id_t? header_settings_p_asserted_id=null

Specifies whether to add a P-Asserted-Identity header when forwarding messages received on this adjacency. If a P-Asserted-Identity header already exists, the new header replaces it. You must set this on the inbound adjacency.

attribute bool? header_settings_p_asserted_id_use_default=null

Specifies whether to add a P-Asserted-Identity header when forwarding messages received on this adjacency. If a P-Asserted-Identity header already exists, the new header replaces it. You must set this on the inbound adjacency.

attribute perimeta::adjacency::sip_interop_p_asserted_id_header_t? p_asserted_id_header=null

Specifies the value of the P-Asserted-Identity header to add to the message when forwarding it.

attribute perimeta::adjacency::sip_interop_header_settings_p_attestation_indicator_t? header_settings_p_attestation_indicator=null

Specifies whether to add a P-Attestation-Indicator header to the message. P-Attestation-Indicator headers are used by the Session Controller when creating a signing request for SIP request signing and when generating a custom verstat value after SIP request verification. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? header_settings_p_attestation_indicator_use_default=null

Specifies whether to add a P-Attestation-Indicator header to the message. P-Attestation-Indicator headers are used by the Session Controller when creating a signing request for SIP request signing and when generating a custom verstat value after SIP request verification. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::adjacency::sip_interop_p_attestation_ind_header_t? p_attestation_ind_header=null

Specifies the value of the P-Attestation-Indicator header to to add to the message. Specify one of the following. - A - you have a direct authenticated relationship with the calling customer and has established that the calling party is authorized to use the calling telephone number. - B - you have a direct authenticated relationship with the calling customer, but can not verify the calling party number information used for the call. - C - you have no relationship with the initiator of the call. - from-verification - the attestation level that was used during verification.

attribute perimeta::adjacency::sip_interop_header_settings_p_origination_id_t? header_settings_p_origination_id=null

Specifies the value of the P-Origination-Id header to to add to the message. This should be a globally unique identifier for the originator of the signing or verification request, for example the Session Controller.

attribute bool? header_settings_p_origination_id_use_default=null

Specifies the value of the P-Origination-Id header to to add to the message. This should be a globally unique identifier for the originator of the signing or verification request, for example the Session Controller.

attribute perimeta::adjacency::sip_interop_p_origination_id_header_t? p_origination_id_header=null

Specifies the value of the P-Origination-Id header to to add to the message. This should be a globally unique identifier for the originator of the signing or verification request, for example the adjacency. from-verification inserts the identifier of the active instance.

attribute perimeta::adjacency::sip_interop_header_settings_verstat_t? header_settings_verstat=null

Specifies whether to add a verstat parameter to the From or P-Asserted-Identity header in the message. Verstat parameters are used by a verification server as part of a SIP request signing process to determine the call’s level of signing and whether to verify the calling number information. They can also be used to mark unsigned calls. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? header_settings_verstat_use_default=null

Specifies whether to add a verstat parameter to the From or P-Asserted-Identity header in the message. Verstat parameters are used by a verification server as part of a SIP request signing process to determine the call’s level of signing and whether to verify the calling number information. They can also be used to mark unsigned calls. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::adjacency::sip_interop_verstat_parameter_t? verstat_parameter=null

Specifies the value of the verstat parameter to add. Specify one of the following. - from-verification - the verstat value produced by the verification server (or, if you have configured the Session Controller to generate a new value using the value from the verification server, the call’s attestation level, and the verification schema, this new value). - TN-Validation-Passed - TN-Validation-Failed - No-TN-Validation

attribute perimeta::adjacency::sip_interop_header_settings_reason_t? header_settings_reason=null

Specifies whether to add a Reason header to all 18X and final responses when SIP request verification fails .

attribute bool? header_settings_reason_use_default=null

Specifies whether to add a Reason header to all 18X and final responses when SIP request verification fails .

attribute perimeta::adjacency::sip_interop_ms_teams_version_header_t? ms_teams_version_header=null

Microsoft Teams requires an X-MS-SBC header specifying the SBC vendor, model and version on all outbound SIP messages in calls and SIP OPTIONs pings. This command adds the header to all relevant messages on this adjacency.

attribute bool? ms_teams_version_header_use_default=null

Microsoft Teams requires an X-MS-SBC header specifying the SBC vendor, model and version on all outbound SIP messages in calls and SIP OPTIONs pings. This command adds the header to all relevant messages on this adjacency.

attribute perimeta::adjacency::sip_interop_3xx_embedded_headers_t? x_3xx_embedded_headers=null

Allows you to configure the Session Controller to pass through certain header types if they are embedded in a Contact header included in a 3xx response received on this adjacency. You can configure the Session Controller to pass through any of the following header types, including custom headers beginning with X-. - Attestation-Info - Date - Diversion - From - History-Info - Identity - Origination-Id - Privacy - P-Access-Network-Info - P-Asserted-Identity - P-Attestation-Indicator - P-Calling-Party-ID - P-Origination-Id - X- If you want to use a custom X-Header pattern, you should specify the patterns that you want to match in the comma-separated list. For custom X-Headers, as long as the header consists of valid SIP characters, Perimeta passes through the header if it begins with X- and is followed by a pattern that you configured. In the previous example, x-call-id is passed through but x-call is not. Alternatively, you can use the special value none to configure the Session Controller to drop all embedded header types, with the exception of Route headers which are always passed through. If you want to specify one or more header types to pass through, you must set this Property to “specify” and then use the 3xx-embedded-headers-value Property to set your chosen header types. Alternatively, you can set this Property to “none” to prevent the Session Controller from passing through any embedded headers, with the exception of Route headers which are always passed through. Any passed through headers either replace or add to the existing headers of that type depending on the setting of the 3xx-embedded-header-pass-mode field. The exceptions to this are in ADD mode the From and the Date headers, that will always replace the existing header. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html) and Configuring SIP redirections in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPRedirections.html).

attribute bool? x_3xx_embedded_headers_use_default=null

Allows you to configure the Session Controller to pass through certain header types if they are embedded in a Contact header included in a 3xx response received on this adjacency. You can configure the Session Controller to pass through any of the following header types, including custom headers beginning with X-. - Attestation-Info - Date - Diversion - From - History-Info - Identity - Origination-Id - Privacy - P-Access-Network-Info - P-Asserted-Identity - P-Attestation-Indicator - P-Calling-Party-ID - P-Origination-Id - X- If you want to use a custom X-Header pattern, you should specify the patterns that you want to match in the comma-separated list. For custom X-Headers, as long as the header consists of valid SIP characters, Perimeta passes through the header if it begins with X- and is followed by a pattern that you configured. In the previous example, x-call-id is passed through but x-call is not. Alternatively, you can use the special value none to configure the Session Controller to drop all embedded header types, with the exception of Route headers which are always passed through. If you want to specify one or more header types to pass through, you must set this Property to “specify” and then use the 3xx-embedded-headers-value Property to set your chosen header types. Alternatively, you can set this Property to “none” to prevent the Session Controller from passing through any embedded headers, with the exception of Route headers which are always passed through. Any passed through headers either replace or add to the existing headers of that type depending on the setting of the 3xx-embedded-header-pass-mode field. The exceptions to this are in ADD mode the From and the Date headers, that will always replace the existing header. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html) and Configuring SIP redirections in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPRedirections.html).

attribute perimeta::adjacency::sip_interop_3xx_embedded_headers_value_t? x_3xx_embedded_headers_value=null

A comma-separated list of embedded header types to pass through on this adjacency. For example, p-asserted-identity,p-access-network-info.

attribute perimeta::adjacency::sip_interop_registration_min_expiry_time_t? registration_min_expiry_time=null

Set the minimum registration expiry time which the Session Controller uses for this adjacency. See Softswitch shielding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SoftswitchShielding.html) for more information.

attribute bool? registration_min_expiry_time_use_default=null

Set the minimum registration expiry time which the Session Controller uses for this adjacency. See Softswitch shielding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SoftswitchShielding.html) for more information.

attribute perimeta::adjacency::sip_interop_registration_fast_register_t? registration_fast_register=null

Enables fast-registration on this adjacency. By default, this enables support for UDP, TCP and TLS endpoints. For information on fast-registration, see Fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FastRegistration.html).

attribute bool? registration_fast_register_use_default=null

Enables fast-registration on this adjacency. By default, this enables support for UDP, TCP and TLS endpoints. For information on fast-registration, see Fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_tcp_t? registration_fast_register_tcp=null

Configures support for fast-registration for endpoints using TCP or TLS. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_tcp_use_default=null

Configures support for fast-registration for endpoints using TCP or TLS. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_interval_t? registration_fast_register_interval=null

Sets the re-registration interval for endpoints behind a device performing NAT. The default is 30 seconds. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_interval_use_default=null

Sets the re-registration interval for endpoints behind a device performing NAT. The default is 30 seconds. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_non_nat_endpoints_t? registration_fast_register_non_nat_endpoints=null

Specifies whether fast-registration is enabled for endpoints that are not behind a device performing NAT. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_non_nat_endpoints_use_default=null

Specifies whether fast-registration is enabled for endpoints that are not behind a device performing NAT. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_non_nat_interval_t? registration_fast_register_non_nat_interval=null

Sets the re-registration interval for endpoints that are not behind a device performing NAT. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_grace_timer_t? registration_fast_register_grace_timer=null

Sets the minimum amount of time the Session Controller will wait after the fast-registration expiry interval before removing the subscriber from its database. The maximum amount of time the Session Controller will wait after the fast-registration expiry interval is the grace period plus the fast-registration expiry interval. The default grace timer period is 120 seconds. To prevent the Session Controller removing the subscriber from its database before the registration on the softswitch expires, set the value to 0. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_grace_timer_use_default=null

Sets the minimum amount of time the Session Controller will wait after the fast-registration expiry interval before removing the subscriber from its database. The maximum amount of time the Session Controller will wait after the fast-registration expiry interval is the grace period plus the fast-registration expiry interval. The default grace timer period is 120 seconds. To prevent the Session Controller removing the subscriber from its database before the registration on the softswitch expires, set the value to 0. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_registration_fast_register_match_on_call_id_t? registration_fast_register_match_on_call_id=null

Enable or disable the match-on-call-id flag. If enabled, fast-registration will be bypassed if the Call-ID on the INVITE message changes. By default this flag is disabled, meaning that fast-registration will continue to be used even if the Call-ID changes. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_match_on_call_id_use_default=null

Enable or disable the match-on-call-id flag. If enabled, fast-registration will be bypassed if the Call-ID on the INVITE message changes. By default this flag is disabled, meaning that fast-registration will continue to be used even if the Call-ID changes. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::adjacency::sip_interop_active_unregister_t? active_unregister=null

Enables Active Unregister. With this feature enabled, the Session Controller will send a de-register to the registrar if a subscriber stops fast-registering or is manually deleted from the subscriber database. For more information see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute bool? active_unregister_use_default=null

Enables Active Unregister. With this feature enabled, the Session Controller will send a de-register to the registrar if a subscriber stops fast-registering or is manually deleted from the subscriber database. For more information see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute perimeta::adjacency::sip_interop_hunting_t? hunting=null

Sets a list of error codes that will trigger hunting for this adjacency. If the Session Controller receives a code that triggers hunting after attempting to route a SIP request, it will retry routing unless the configured limit for retries has been reached. You can also use this command to disable hunting on this adjacency. If this setting is not configured, the Session Controller will use the globally configured list of hunting triggers for this adjacency. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html).

attribute bool? hunting_use_default=null

Sets a list of error codes that will trigger hunting for this adjacency. If the Session Controller receives a code that triggers hunting after attempting to route a SIP request, it will retry routing unless the configured limit for retries has been reached. You can also use this command to disable hunting on this adjacency. If this setting is not configured, the Session Controller will use the globally configured list of hunting triggers for this adjacency. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html).

attribute perimeta::adjacency::sip_interop_hunting_triggers_t? hunting_triggers=null

A list of SIP error codes that will trigger standard hunting if received on this adjacency. Enter a space-separated list of the codes that you want to trigger standard hunting, enclosed in quotation marks, up to a maximum of 255 characters. If you do not enter a value into this field, the Session Controller will use the global list of error codes for standard hunting. Note that the global list of error codes of standard hunting can only be configured through the Perimeta command line interface (CLI) and is not accessible over the REST API.

attribute perimeta::adjacency::sip_interop_options_ping_t? options_ping=null

Enables the use of SIP OPTIONS pings to monitor the availability of the signaling peer (on all configured addresses). For more information, see Peer availability detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerAvailabilityDetection.html).

attribute bool? options_ping_use_default=null

Enables the use of SIP OPTIONS pings to monitor the availability of the signaling peer (on all configured addresses). For more information, see Peer availability detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerAvailabilityDetection.html).

attribute perimeta::adjacency::sip_interop_options_ping_mechanism_t? options_ping_mechanism=null

Specifies the mechanism the Session Controller will use when using SIP OPTIONS pings to monitor the availability of the static signaling peer of this adjacency (on all configured addresses). You can choose between the following mechanisms. - Continuous - The Session Controller will only use responses to SIP OPTIONS requests to identify whether peers are available. It will always send a SIP OPTIONS request at the end of the configured interval, regardless of the traffic that it receives from the peer. - Pause during traffic - The Session Controller will use responses to both SIP OPTIONS requests and other SIP traffic to determine whether peers available. As with continuous polling, the Session Controller will send a SIP OPTIONS request at the end of the configured interval. However, if the Session Controller receives a message of either of the following types from a peer before the interval ends, it will treat this message as an indication that the connection to the peer is still live and will restart the interval without sending a SIP OPTIONS request. - A SIP request - A SIP response to a request (other than a SIP OPTIONS request) with a response code that is included on the list of codes configured to be treated as successes using the non-options-ping-response command. We strongly recommend that you do not use the pause during traffic mechanism if the peer that the Session Controller must monitor is known to handle large amounts of traffic that is prone to short bursts of failures. If the pause during traffic mechanism is used with this type of peer, a short burst of failure responses to normal SIP traffic would cause the Session Controller to mark the connection to the peer as having failed, even though short bursts of failures are expected behavior and not an indication of a failed connection. This will result in the adjacency repeatedly moving between a healthy and a failed state.

attribute bool? options_ping_mechanism_use_default=null

Specifies the mechanism the Session Controller will use when using SIP OPTIONS pings to monitor the availability of the static signaling peer of this adjacency (on all configured addresses). You can choose between the following mechanisms. - Continuous - The Session Controller will only use responses to SIP OPTIONS requests to identify whether peers are available. It will always send a SIP OPTIONS request at the end of the configured interval, regardless of the traffic that it receives from the peer. - Pause during traffic - The Session Controller will use responses to both SIP OPTIONS requests and other SIP traffic to determine whether peers available. As with continuous polling, the Session Controller will send a SIP OPTIONS request at the end of the configured interval. However, if the Session Controller receives a message of either of the following types from a peer before the interval ends, it will treat this message as an indication that the connection to the peer is still live and will restart the interval without sending a SIP OPTIONS request. - A SIP request - A SIP response to a request (other than a SIP OPTIONS request) with a response code that is included on the list of codes configured to be treated as successes using the non-options-ping-response command. We strongly recommend that you do not use the pause during traffic mechanism if the peer that the Session Controller must monitor is known to handle large amounts of traffic that is prone to short bursts of failures. If the pause during traffic mechanism is used with this type of peer, a short burst of failure responses to normal SIP traffic would cause the Session Controller to mark the connection to the peer as having failed, even though short bursts of failures are expected behavior and not an indication of a failed connection. This will result in the adjacency repeatedly moving between a healthy and a failed state.

attribute perimeta::adjacency::sip_interop_options_ping_response_t? options_ping_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes.

attribute bool? options_ping_response_use_default=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes.

attribute perimeta::adjacency::sip_interop_options_ping_response_success_codes_t? options_ping_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::adjacency::sip_interop_options_ping_response_failure_codes_t? options_ping_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::adjacency::sip_interop_other_sip_response_t? other_sip_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a request other than a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the other-sip-response-success-codes Property to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the other-sip-response-failure-codes Property to specify your chosen list of response codes.

attribute bool? other_sip_response_use_default=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a request other than a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the other-sip-response-success-codes Property to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the other-sip-response-failure-codes Property to specify your chosen list of response codes.

attribute perimeta::adjacency::sip_interop_other_sip_response_success_codes_t? other_sip_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a request other than a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::adjacency::sip_interop_other_sip_response_failure_codes_t? other_sip_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a request other than a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::adjacency::sip_interop_options_ping_failure_threshold_t? options_ping_failure_threshold=null

The number of consecutive failures necessary for the Session Controller to treat a connection as having failed. The Session Controller will register a failure in the following circumstances. - The Session Controller does not receive a response to a SIP OPTIONS request from the static signaling peer within the configured interval. - The Session Controller receives a response from the static signaling peer to a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the options-ping-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the options-ping-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will identify any response with a 3XX response code as a failure. - (Pause during traffic mechanism only) The Session Controller receives a response from the static signaling peer to any SIP request other than a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the other-sip-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the other-sip-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will not identify any response codes as failures.

attribute bool? options_ping_failure_threshold_use_default=null

The number of consecutive failures necessary for the Session Controller to treat a connection as having failed. The Session Controller will register a failure in the following circumstances. - The Session Controller does not receive a response to a SIP OPTIONS request from the static signaling peer within the configured interval. - The Session Controller receives a response from the static signaling peer to a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the options-ping-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the options-ping-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will identify any response with a 3XX response code as a failure. - (Pause during traffic mechanism only) The Session Controller receives a response from the static signaling peer to any SIP request other than a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the other-sip-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the other-sip-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will not identify any response codes as failures.

attribute perimeta::adjacency::sip_interop_options_ping_interval_t? options_ping_interval=null

Sets the interval between sending each SIP OPTIONS ping (seconds).

attribute bool? options_ping_interval_use_default=null

Sets the interval between sending each SIP OPTIONS ping (seconds).

attribute perimeta::adjacency::sip_interop_options_ping_lifetime_t? options_ping_lifetime=null

Sets the amount of time that the Session Controller should wait for the response to a given ping.

attribute bool? options_ping_lifetime_use_default=null

Sets the amount of time that the Session Controller should wait for the response to a given ping.

attribute perimeta::adjacency::sip_interop_options_ping_max_forwards_t? options_ping_max_forwards=null

Configures the value of Max-Forwards header on generated OPTIONS pings

attribute bool? options_ping_max_forwards_use_default=null

Configures the value of Max-Forwards header on generated OPTIONS pings

attribute perimeta::adjacency::sip_interop_respond_when_no_username_t? respond_when_no_username=null

Specifies how the Session Controller will handle OPTIONS requests received on this adjacency with no username in the request-URI. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute bool? respond_when_no_username_use_default=null

Specifies how the Session Controller will handle OPTIONS requests received on this adjacency with no username in the request-URI. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute perimeta::adjacency::sip_interop_respond_when_no_username_max_forwards_limit_t? respond_when_no_username_max_forwards_limit=null

Specifies the maximum Max-Forwards header value on an OPTIONS request with no username in the request-URI to which the Session Controller will respond directly. If the value of the Max-Forwards header on an OPTIONS request is less than or equal to the value specified in this Property, the Session Controller will respond directly to it with a 200 OK. If the value of the Max-Forwards header on an OPTIONS request is more than the value specified in this Property, the Session Controller will route and forward the request.

attribute perimeta::adjacency::sip_interop_respond_when_username_t? respond_when_username=null

Specifies how the Session Controller will handle OPTIONS requests received on this adjacency with a username in the request-URI. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute bool? respond_when_username_use_default=null

Specifies how the Session Controller will handle OPTIONS requests received on this adjacency with a username in the request-URI. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute perimeta::adjacency::sip_interop_respond_when_username_max_forwards_limit_t? respond_when_username_max_forwards_limit=null

Specifies the maximum Max-Forwards header value on an OPTIONS request with a username in the request-URI to which the Session Controller will respond directly. If the value of the Max-Forwards header on an OPTIONS request is less than or equal to the value specified in this Property, the Session Controller will respond directly to it with a 200 OK. If the value of the Max-Forwards header on an OPTIONS request is more than the value specified in this Property, the Session Controller will route and forward the request.

attribute perimeta::adjacency::sip_interop_edit_profiles_inbound_t? edit_profiles_inbound=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to inbound messages on this adjacency. This must be a comma-separated list of SIP Message Manipulation Profiles. For information on default profiles, which are determined by adjacency type, see Adjacency types in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/AdjacencyTypes.html). For more information on applying profiles to an adjacency, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute bool? edit_profiles_inbound_use_default=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to inbound messages on this adjacency. This must be a comma-separated list of SIP Message Manipulation Profiles. For information on default profiles, which are determined by adjacency type, see Adjacency types in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/AdjacencyTypes.html). For more information on applying profiles to an adjacency, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute perimeta::adjacency::sip_interop_edit_profiles_outbound_t? edit_profiles_outbound=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to outbound messages on this adjacency. This must be a comma-separated list of SIP Message Manipulation Profiles. For information on default profiles, which are determined by adjacency type, see Adjacency types in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/AdjacencyTypes.html). For more information on applying profiles to an adjacency, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute bool? edit_profiles_outbound_use_default=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to outbound messages on this adjacency. This must be a comma-separated list of SIP Message Manipulation Profiles. For information on default profiles, which are determined by adjacency type, see Adjacency types in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/AdjacencyTypes.html). For more information on applying profiles to an adjacency, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute perimeta::adjacency::sip_interop_custom_data_t? custom_data=null

A piece of arbitrary data that can be referenced in Message Manipulation profiles. Set a key and a value for the data, and it can be used in edit profiles as a variable: ${adj.custom_data.key}. The only characters allowed in a variable name are alphanumeric, ‘_’, and ‘.’.

attribute perimeta::adjacency::sip_interop_custom_data_key_t? custom_data_key=null

Name of the custom data

attribute perimeta::adjacency::sip_interop_custom_data_value_t? custom_data_value=null

Value of the custom data

attribute perimeta::adjacency::sip_interop_dtmf_force_passthrough_t? dtmf_force_passthrough=null

Specifies whether the Session Controller must passthrough all DTMF (in the signaling or media plane) sent or received on this adjacency, preventing any DTMF interworking.

attribute bool? dtmf_force_passthrough_use_default=null

Specifies whether the Session Controller must passthrough all DTMF (in the signaling or media plane) sent or received on this adjacency, preventing any DTMF interworking.

attribute perimeta::adjacency::sip_interop_dtmf_preferred_method_t? dtmf_preferred_method=null

Specifies the preferred method for DTMF in SIP.

attribute bool? dtmf_preferred_method_use_default=null

Specifies the preferred method for DTMF in SIP.

attribute perimeta::adjacency::sip_interop_dtmf_sip_notify_t? dtmf_sip_notify=null

Specifies whether the Session Controller must auto-detect or disable the use of SIP NOTIFY for transmitting DTMF.

attribute bool? dtmf_sip_notify_use_default=null

Specifies whether the Session Controller must auto-detect or disable the use of SIP NOTIFY for transmitting DTMF.

attribute perimeta::adjacency::sip_interop_dtmf_sip_info_t? dtmf_sip_info=null

Specifies whether the Session Controller should disable, detect support for or assume support for DTMF using SIP INFO.

attribute bool? dtmf_sip_info_use_default=null

Specifies whether the Session Controller should disable, detect support for or assume support for DTMF using SIP INFO.

attribute perimeta::adjacency::sip_interop_session_timer_mode_t? session_timer_mode=null

Sets the session timer mode for this adjacency. Session timers provide a keepalive mechanism for SIP sessions and set an upper limit on the amount of time for which a failed session can continue. For more information, see Session timers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SessionTimers.html).

attribute perimeta::adjacency::sip_interop_session_timer_min_session_expiry_t? session_timer_min_session_expiry=null

Minimum session expiry time in seconds or minutes

attribute perimeta::adjacency::sip_interop_session_timer_min_session_expiry_units_t? session_timer_min_session_expiry_units=null

Units

attribute perimeta::adjacency::sip_interop_session_timer_preferred_session_expiry_t? session_timer_preferred_session_expiry=null

Sets the preferred duration of a session timer. Proxies may decrease this value, provided it continues to be greater than the minimum duration.

attribute perimeta::adjacency::sip_interop_session_timer_preferred_session_expiry_units_t? session_timer_preferred_session_expiry_units=null

Units

attribute perimeta::adjacency::sip_interop_session_timer_preferred_refresh_originator_t? session_timer_preferred_refresh_originator=null

Specifies whether the Session Controller or the other device should initiate session refresh requests.

attribute perimeta::adjacency::sip_interop_preconditions_t? preconditions=null

Configures whether the Session Controller should carry out preconditions interworking for calls using this adjacency as the outbound adjacency. Preconditions allow endpoints to reserve media resouces for calls. For more information, see Preconditions support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PreconditionsSupport.html) .

attribute bool? preconditions_use_default=null

Configures whether the Session Controller should carry out preconditions interworking for calls using this adjacency as the outbound adjacency. Preconditions allow endpoints to reserve media resouces for calls. For more information, see Preconditions support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PreconditionsSupport.html) .

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_interop_config

• perimeta::adjacency::sip_interop_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_interop_config, perimeta::adjacency::sip_interop_cross_device_relations constraint true

entity perimeta::adjacency::SipInteropIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/interop Perimeta API resource. Abstract base entity. For concrete usage, see children SipInterop and SipInteropUnmanaged.

Configuration mode that includes commands relating to SIP device interoperability options. These commands are all available through adjacency interoperability profiles - commands configured in this mode will override any interoperability profile applied to the adjacency.

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.interop [0:1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_interop_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_interop_uri constraint true

entity perimeta::adjacency::SipInteropUnmanaged

Parents: perimeta::adjacency::SipInteropIdentity

Unmanaged reference to a /adjacency/sip/interop Perimeta API resource.

Configuration mode that includes commands relating to SIP device interoperability options. These commands are all available through adjacency interoperability profiles - commands configured in this mode will override any interoperability profile applied to the adjacency.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipTrafficGroup

Parents: perimeta::adjacency::SipTrafficGroupIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/traffic-group Perimeta API resource.

Creates a traffic group on this adjacency or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this adjacency, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_traffic_group_privacy_t? privacy=null

Sets whether the Session Controller should treat the traffic group as trusted for the purposes of SIP privacy. If the traffic group is untrusted, the Session Controller will strip user identifiers from SIP messages with a Privacy header before forwarding them into the adjacency on which this traffic group is configured. For more information, see SIP privacy support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPPrivacySupport.html).

attribute bool? privacy_use_default=null

Sets whether the Session Controller should treat the traffic group as trusted for the purposes of SIP privacy. If the traffic group is untrusted, the Session Controller will strip user identifiers from SIP messages with a Privacy header before forwarding them into the adjacency on which this traffic group is configured. For more information, see SIP privacy support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPPrivacySupport.html).

attribute perimeta::adjacency::sip_traffic_group_msc_location_id_t? msc_location_id=null

Sets the media location ID for this traffic group. The Session Controller uses the location ID to select the correct MSC for media traffic to and from the traffic group. By default, a traffic group inherits the MSC location ID of the adjacency it is configured on. You can choose whether this MSC location ID overrides any MSC location ID configured on the adjacency or is only used if neither adjacency in the call has a MSC location ID explicitly configured.

attribute perimeta::adjacency::sip_traffic_group_msc_location_id_value_t? msc_location_id_value=null

Sets a specific media location ID for this traffic group.

attribute perimeta::adjacency::sip_traffic_group_msc_location_id_precedence_t? msc_location_id_precedence=null

Specifies whether the MSC location ID on the traffic group overrides the MSC location ID configured on the adjacency.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_config

• perimeta::adjacency::sip_traffic_group_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_config, perimeta::adjacency::sip_traffic_group_cross_device_relations constraint true

entity perimeta::adjacency::SipTrafficGroupCallLimits

Parents: perimeta::adjacency::SipTrafficGroupCallLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/traffic-group/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_traffic_group_call_limits_max_media_renegotiations_t? max_media_renegotiations=null

Sets the maximum number of media renegotiations per call for this traffic group.

attribute bool? max_media_renegotiations_use_default=null

Sets the maximum number of media renegotiations per call for this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_limits_media_streams_t? media_streams=null

Sets a maximum number of media streams per call for this traffic group.

attribute bool? media_streams_use_default=null

Sets a maximum number of media streams per call for this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_limits_max_call_duration_t? max_call_duration=null

Set the maximum duration in seconds for a call on this traffic group.

attribute bool? max_call_duration_use_default=null

Set the maximum duration in seconds for a call on this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_limits_max_bandwidth_t? max_bandwidth=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this traffic group. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? max_bandwidth_use_default=null

Sets the maximum bandwidth (in bits per second) that the Session Controller can allocate to an individual call made from this traffic group. The treatment of calls with a bandwidth requirement that exceeds this limit is determined by the bandwidth policing mode call policy. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_call_limits_config

• perimeta::adjacency::sip_traffic_group_call_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_call_limits_config, perimeta::adjacency::sip_traffic_group_call_limits_cross_device_relations constraint true

entity perimeta::adjacency::SipTrafficGroupCallLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/traffic-group/call-limits Perimeta API resource. Abstract base entity. For concrete usage, see children SipTrafficGroupCallLimits and SipTrafficGroupCallLimitsUnmanaged.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

relation perimeta::adjacency::SipTrafficGroupIdentity sip_traffic_group [1]

other end: perimeta::adjacency::SipTrafficGroupIdentity.call_limits [0:1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_call_limits_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_call_limits_uri constraint true

entity perimeta::adjacency::SipTrafficGroupCallLimitsUnmanaged

Parents: perimeta::adjacency::SipTrafficGroupCallLimitsIdentity

Unmanaged reference to a /adjacency/sip/traffic-group/call-limits Perimeta API resource.

Configuration mode for capacity control limits applying to individual calls involving this traffic group. For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipTrafficGroupCallMediaPolicy

Parents: perimeta::adjacency::SipTrafficGroupCallMediaPolicyIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/traffic-group/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls on this adjacency with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant adjacency setting will be applied if the adjacency has the setting configured (or the account setting, if the setting has not been configured on the adjacency and the adjacency is part of an account on which the setting has been configured).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_ice_lite_t? ice_lite=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this traffic-group. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute bool? ice_lite_use_default=null

Specifies whether the Session Controller should originate and terminate ICE Lite procedures for calls using this traffic-group. For more information, see ICE Lite for Microsoft Teams media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ICELiteForMicrosoftTeamsMediaBypass.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_media_bypass_policy_t? media_bypass_policy=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls using this traffic group. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute bool? media_bypass_policy_use_default=null

Sets the media bypass policy, which determines whether or not the Session Controller can perform media bypass for calls using this traffic group. Media bypass allows the media stream to pass directly between the endpoints in a call, without being handled by the Session Controller. For more information, see Media bypass in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaBypass.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_active_call_bypass_t? active_call_bypass=null

Determines whether the Session Controller permits media bypass for active calls using this traffic group, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls using traffic groups that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls using traffic groups that are used to connect to the endpoints in calls.

attribute bool? active_call_bypass_use_default=null

Determines whether the Session Controller permits media bypass for active calls using this traffic group, allowing an intermediate device to either add itself to or remove itself from the media path of an existing end-to-end call. You must only allow media bypass for active calls using traffic groups that are used to connect to intermediate devices, such as softswitches. You must not allow media bypass for active calls using traffic groups that are used to connect to the endpoints in calls.

attribute bool? supported_codecs_use_default=null

Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? preferred_codecs_use_default=null

Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

attribute bool? non_audio_video_codecs_use_default=null

Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

attribute bool? preferred_payload_types_use_default=null

Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_comfort_noise_codec_t? comfort_noise_codec=null

Specifies whether the Session Controller should perform comfort noise interworking for calls using this traffic-group. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? comfort_noise_codec_use_default=null

Specifies whether the Session Controller should perform comfort noise interworking for calls using this traffic-group. For more information, see Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html).

attribute bool? transcoding=null

Enables transcoding for calls using this traffic group. See Media transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaTranscoding.html) for more information.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_transcoding_trigger_t? transcoding_trigger=null

Sets the transcoding trigger for this traffic group, which controls when calls enter transcoding mode. Transcoding mode means Perimeta will add codecs that require transcoding to SDP offers; it does not always mean the call will necessarily use transcoding, since endpoints can select a non-transcoding codec. For more details see Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? answer_generation_match_fidelity=null

Specifies that the Session Controller should choose a codec for its answer to the inbound offer that causes the same fidelity (standard definition (SD) or high definition (HD)) to be used on each side of the call when transcoding and using this traffic group. This is only possible if the inbound offer contained both SD and HD codecs. You must set this on the caller’s side of the call. If the caller offers both SD and HD codecs, you can use this to prevent SD-to-HD or HD-to-SD transcoding. These combinations use more resources than SD-to-SD transcoding and provide worse call quality than HD-to-HD transcoding. For more background information, see Matching codec fidelities in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool? tty_interwork_from_rfc4103=null

Specifies whether the Session Controller should interwork between RFC 4103 Real-Time Text (RTT) and Text Telephone (TTY). The Session Controller always initially passes through an RTT offer. If this configuration is set, the Session Controller initiates interworking after receiving either a 200 with a disabled text media stream or no text media stream present, a 415, or a 488 response to an RTT offer. This feature is only available on systems with software transcoding enabled. For more information on configuring Perimeta to interwork from RTT to TTY, see RTT and TTY interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTTAndTTYInterworking.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_t? fax_transcoding=null

Enables fax transcoding on calls using this traffic group and specifies the fax transport protocol for the Session Controller to use. If you select T.38, the Session Controller will use T.38 for fax calls if possible, but will use G.711 if T.38 is not available. If you select G.711, the Session Controller will never use T.38 for fax calls using this traffic group. For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_default_pcm_type_t? fax_transcoding_default_pcm_type=null

Specifies the PCM variant that the Session Controller must use when generating a fax transcoding offer for calls using this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_jitter_buffer_size_t? fax_transcoding_jitter_buffer_size=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute bool? fax_transcoding_jitter_buffer_size_use_default=null

Specifies the size in milliseconds of the fixed jitter buffer for fax transcoding. If set to 0, the jitter buffer will be disabled on fax transcoding calls. If not set at any scope, fax transcoding calls use the all calls jitter buffer if it is configured. Metaswitch recommends that you do not let fax calls use the adaptive all calls jitter buffer because packets may be lost when the buffer shrinks.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_generate_reinvite_t? fax_transcoding_generate_reinvite=null

Specifies whether the Session Controller should detect fax tones on G.711 calls made through this traffic group and generate T.38 reINVITEs when required. If you set this Property to enabled, the Session Controller will generate a T.38 reINVITE on detection of a V.21 flag from the receiving fax machine or gateway. If you set this Property to on-cng, the Session Controller will generate a T.38 reINVITE on detection of a CNG tone from either side of the fax call.

attribute bool? fax_transcoding_retry_on_4xx=null

Specifies that the Session Controller should invoke fax transcoding and use G.711 on this traffic groups’s leg of the call if it receives a 4xx response to an original T.38 offer. You must only set this Property to true if the Session Controller is configured to use T.38 for fax transcoding on this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_fax_transcoding_tone_detection_mode_t? fax_transcoding_tone_detection_mode=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute bool? fax_transcoding_tone_detection_mode_use_default=null

Determines when the Session Controller detects inband fax tones. By default, the Session Controller detects inband fax tones when the sides of the call are configured to use different fax transport protocols. Alternatively, to reduce resource usage, you can configure the Session Controller to detect inband fax tones only when transcoding from PCM (G.711). For more information, see Fax transcoding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FaxTranscoding.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_inband_tones_t? inband_tones=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints when this traffic group is applied to a call. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. For more information, see DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html).

attribute bool? inband_tones_use_default=null

Configures whether inband DTMF tones are sent in the audio stream by endpoints when this traffic group is applied to a call. If this is set to ‘present’, and ‘inband-tone-interworking on-transcode’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on this side of the call. For more information, see DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_inband_tone_interworking_t? inband_tone_interworking=null

Enables or disables inband DTMF interworking for this side of a call with this traffic group applied. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? inband_tone_interworking_use_default=null

Enables or disables inband DTMF interworking for this side of a call with this traffic group applied. If this is set to ‘on-transcode’, and ‘inband-tones present’ is set on the other side of the call, Perimeta will perform inband DTMF interworking for transcoding calls with G.711 on the other side of the call. See DTMF interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DTMFInterworking.html) for more information.

attribute bool? repeat_sdp_on_18x=null

Configures the Session Controller to add a repeat of the agreed SDP to provisional “18x” responses after the initial successful INVITE offer-answer exchange for calls made using this traffic group on the outbound side. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute bool? repeat_sdp_on_200ok=null

Configures the Session Controller to add a repeat of the agreed SDP to the 200 OK response for calls made using this traffic group on the outbound side. For more information, see Repeated SDP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RepeatedSDP.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_session_refresh_sdp_renegotiation_on_pass_through_t? session_refresh_sdp_renegotiation_on_pass_through=null

Configures whether the Session Controller supports SDP renegotiation on calls using this traffic group if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices involved in calls on this traffic group to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation if this traffic group will be used for calls using paired media bypass. If you set this command to ‘inherit’, the traffic group will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute bool? session_refresh_sdp_renegotiation_on_pass_through_use_default=null

Configures whether the Session Controller supports SDP renegotiation on calls using this traffic group if it passes through a session refresh request with repeated SDP and subsequently receives a response with changed SDP. You must only allow SDP renegotiation if you expect devices involved in calls on this traffic group to use updated SDP on a response to a session refresh request. Additionally, you must not allow SDP renegotiation if this traffic group will be used for calls using paired media bypass. If you set this command to ‘inherit’, the traffic group will inherit its behavior from the configuration of another object involved in the call, as described in Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). If all objects involved in a call are configured to ‘inherit’, the Session Controller will suppress SDP renegotiation. For more information, see Handling updates to SDP on responses to session refresh requests in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/HandlingUpdatesToSDPOnResponsesToSessionRefreshRequests.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_hold_indicator_t? hold_indicator=null

Sets the method or combination of methods that the Session Controller should use when signaling call hold to endpoints in this traffic group. The default (when no configured traffic group applies) is standard. For more information, see Call hold interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallHoldInterworking.html).

attribute bool? ignore_sdp_bandwidth_fields=null

Configures the Session Controller to ignore ‘b=’ lines in SDP and to calculate bandwidth requirements for a call based on the codecs used when this traffic group is applied. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_secure_media_t? secure_media=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this traffic group. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? secure_media_use_default=null

Configures the Session Controller to allow (when used without parameters) or require SRTP on this traffic group. Optionally configures the Session Controller to expect unsignaled SRTP. For more information, see SRTP and RTP/SRTP interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SRTPAndRTPSRTPInterworking.html).

attribute bool? strip_all_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all disabled media descriptions from SDP offers using this traffic group.

attribute bool? strip_new_disabled_media_descriptions_from_offers=null

Specifies whether the Session Controller will strip all new disabled media descriptions from SDP offers using this traffic group. New streams are those that are unknown to the recipient. All streams in an initial offer are new, as are any streams added to a reoffer.

attribute bool? strip_disabled_media_descriptions_from_answers=null

Specifies whether the Session Controller will strip all disabled media descriptions from forwarded answers using this traffic group. Note that setting this Property to true violates RFC 3264.

attribute bool? disabled_media_descriptions_pad_offers=null

Specifies whether the Session Controller will pad reoffers on this traffic group with dummy media lines to replace lines removed by the sender.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_early_media_timeout_t? early_media_timeout=null

Sets a maximum length of time for which early media is allowed on calls when this traffic group is applied. If the call is not connected within this time period, it will be torn down.

attribute bool? early_media_timeout_use_default=null

Sets a maximum length of time for which early media is allowed on calls when this traffic group is applied. If the call is not connected within this time period, it will be torn down.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_early_media_p_early_media_t? early_media_p_early_media=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this traffic group.

attribute bool? early_media_p_early_media_use_default=null

Specifies how the Session Controller will handle P-Early-Media headers sent or received on this traffic group.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_bandwidth_policing_mode_t? bandwidth_policing_mode=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute bool? bandwidth_policing_mode_use_default=null

Determines how the Session Controller treats a call when its calculated bandwidth requirement exceeds applicable capacity control limits. For more information, see Bandwidth allocation process in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/BandwidthAllocationProcess.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_force_ptime_t? force_ptime=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute bool? force_ptime_use_default=null

Forces a packetization time (milliseconds) to be used on this side of the call. You can either specify or set this dynamically. For more information on transrating, see Transrating in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Transrating.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_force_ptime_value_t? force_ptime_value=null

Specifies the packetization time (in milliseconds) to be used on this side of the call.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_suppression_t? rtcp_suppression=null

Specifies how the Session Controller should handle RTCP packets for calls using this traffic group. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute bool? rtcp_suppression_use_default=null

Specifies how the Session Controller should handle RTCP packets for calls using this traffic group. RTCP behavior depends on the policy on both sides of the call; see Per-side RTCP in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PerSideRTCP.html). Note that this resource corresponds to the CLI command “rtcp-transmission-policy”.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_multiplexing_t? rtcp_multiplexing=null

Enables RTP/RTCP multiplexing on calls using this traffic group. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute bool? rtcp_multiplexing_use_default=null

Enables RTP/RTCP multiplexing on calls using this traffic group. Enabling RTP/RTCP multiplexing allows the Session Controller to transmit both RTP and RTCP packets on a single UDP port, if support for multiplexing is signalled by the endpoint on this side of the call. For more information, see RTP/RTCP Multiplexing in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.7/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPRTCPMultiplexing.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_rtcp_xr_block_types_t? rtcp_xr_block_types=null

Specifies any requested RTCP-XR block types on this traffic group

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_t? all_calls_jitter_buffer=null

Controls whether a jitter buffer is enabled for all calls using this traffic group. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute bool? all_calls_jitter_buffer_use_default=null

Controls whether a jitter buffer is enabled for all calls using this traffic group. For more information, see All calls jitter buffer in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/AllCallsJitterBuffer.html).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_size_t? all_calls_jitter_buffer_size=null

Set the fixed size (Fixed Mode) or initial size (Adaptive mode) for the jitter buffer in milliseconds

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_max_size_t? all_calls_jitter_buffer_max_size=null

Specifies the maximum capacity of the all calls jitter buffer.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_min_size_t? all_calls_jitter_buffer_min_size=null

Specifies the minimum capacity of the all calls jitter buffer.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_step_size_t? all_calls_jitter_buffer_step_size=null

Specifies the size by which the capacity of the all calls jitter buffer should change in response to packet delay variation.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_all_calls_jitter_buffer_step_rate_t? all_calls_jitter_buffer_step_rate=null

Specifies how frequently the capacity of the all calls jitter buffer should change. This is expressed as a percentage of the size of the buffer.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_media_capture_percentage_t? media_capture_percentage=null

Configures the probability that the media for an individual call in this traffic group is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute bool? media_capture_percentage_use_default=null

Configures the probability that the media for an individual call in this traffic group is sent to the Service Assurance Server for troubleshooting. Compatible versions of the Service Assurance Server allow you to export the media in a packet capture. Set an integer value in the range 0-100. 0 ensures that the media is never captured. 100 ensures that the media is always captured (unless the other side of the call is configured with a value of 0). If both sides of the call are configured with a value other than 0, the Session Controller uses the higher value to determine the probability that the call is captured. For an overview, see Media capture with the Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/MediaCaptureWithTheServiceAssuranceServer).

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_media_latching_t? media_latching=null

Specifies whether media latching should be disabled for traffic on this traffic group. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute bool? media_latching_use_default=null

Specifies whether media latching should be disabled for traffic on this traffic group. If media latching is disabled, the Session Controller will only accept media from the address agreed in the SDP. If outbound media latching is disabled, the Session Controller will always send media to the address agreed in the SDP, ignoring where it is receiving media from. Inbound media latching will still occur, but will only be used to restrict the sources from which the Session Controller will accept media.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_media_timeout_t? media_timeout=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute bool? media_timeout_use_default=null

Specifies the amount of time in seconds for which media must stop flowing before Perimeta will end a call.

attribute perimeta::adjacency::sip_traffic_group_call_media_policy_remove_csrc_t? remove_csrc=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool? remove_csrc_use_default=null

Specifies whether CSRC information is removed from inbound RTP packet headers. This sets the CSRC count to zero, and removes the CSRC identifiers from the RTP header. For more information, see Removing CSRC identifiers from an RTP header in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RemovingCSRCFromAnRTPHeader.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel supported_codecs: Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel preferred_codecs: Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html). :rel non_audio_video_codecs: Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html). :rel preferred_payload_types: Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group. :rel offer_generation_codec_template: Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers for calls using this traffic group. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers. :rel qos_sig_profile: Sets a Quality of Service profile to apply to signaling packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_video_profile: Sets a Quality of Service profile to apply to video media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_voice_profile: Sets a Quality of Service profile to apply to voice media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html). :rel qos_msrp_profile: Sets a Quality of Service profile to apply to MSRP media packets routed into this traffic group. This determines what the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

relation perimeta::codec_list::CodecListIdentity supported_codecs [0:1]

Sets a codec allowlist to use with this traffic group. For more information, see Codec lists in Perimeta Configuration

and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_codecs [0:1]

Sets a codec preference list to use on calls using this traffic group. For more information, see Codec lists in Perimeta

Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CodecLists.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity non_audio_video_codecs [0:1]

Sets a codec (media types) allowlist for non audio/video media streams to use with this traffic group. The only current

non audio/video media type is MSRP. For more information, see MSRP support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSRPSupport.html).

Peer relation:

relation perimeta::codec_list::CodecListIdentity preferred_payload_types [0:1]

Sets the RTP payload type preference list to use for calls using this traffic group. An RTP payload type preference list

allows you to control the RTP payload types used for specific codecs on this side of the call. The Session Controller will interwork between the specified payload type and the payload type in use on the other side of the call when sending SDP and RTP towards endpoints using this traffic group.

Peer relation:

relation perimeta::codec_list::CodecListIdentity offer_generation_codec_template [0:1]

Applies a codec list that specifies the codecs the Session Controller will add to transcoding offers for calls using

this traffic group. If you do not use this setting, the Session Controller will add all available codecs (based on Perimeta support and your Session Controller license) to transcoding offers.

Peer relation:

relation perimeta::qos::SigIdentity qos_sig_profile [0:1]

Sets a Quality of Service profile to apply to signaling packets routed into this traffic group. This determines what the

Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VideoIdentity qos_video_profile [0:1]

Sets a Quality of Service profile to apply to video media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::VoiceIdentity qos_voice_profile [0:1]

Sets a Quality of Service profile to apply to voice media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

relation perimeta::qos::MsrpIdentity qos_msrp_profile [0:1]

Sets a Quality of Service profile to apply to MSRP media packets routed into this traffic group. This determines what

the Session Controller sets the IP TOS header field to for these packets. The profile must have been previously configured on the Session Controller. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_call_media_policy_config

• perimeta::adjacency::sip_traffic_group_call_media_policy_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_call_media_policy_config, perimeta::adjacency::sip_traffic_group_call_media_policy_cross_device_relations constraint true

entity perimeta::adjacency::SipTrafficGroupCallMediaPolicyIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/traffic-group/call-media-policy Perimeta API resource. Abstract base entity. For concrete usage, see children SipTrafficGroupCallMediaPolicy and SipTrafficGroupCallMediaPolicyUnmanaged.

Configuration mode for call media policies affecting calls on this adjacency with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant adjacency setting will be applied if the adjacency has the setting configured (or the account setting, if the setting has not been configured on the adjacency and the adjacency is part of an account on which the setting has been configured).

relation perimeta::adjacency::SipTrafficGroupIdentity sip_traffic_group [1]

other end: perimeta::adjacency::SipTrafficGroupIdentity.call_media_policy [0:1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_call_media_policy_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_call_media_policy_uri constraint true

entity perimeta::adjacency::SipTrafficGroupCallMediaPolicyUnmanaged

Parents: perimeta::adjacency::SipTrafficGroupCallMediaPolicyIdentity

Unmanaged reference to a /adjacency/sip/traffic-group/call-media-policy Perimeta API resource.

Configuration mode for call media policies affecting calls on this adjacency with this traffic group applied. These settings control a variety of features of calls. For more information, see Call media policies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/CallMediaPolicies.html) and Call media policy details in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CallMediaPolicyDetails.html). When a setting is not configured, the relevant adjacency setting will be applied if the adjacency has the setting configured (or the account setting, if the setting has not been configured on the adjacency and the adjacency is part of an account on which the setting has been configured).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipTrafficGroupIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/traffic-group Perimeta API resource. Abstract base entity. For concrete usage, see children SipTrafficGroup and SipTrafficGroupUnmanaged.

Creates a traffic group on this adjacency or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this adjacency, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

attribute perimeta::adjacency::sip_traffic_group_traffic_group_t traffic_group

Name of the traffic group. Specify a string of up to 22 alphanumeric characters.

relation perimeta::adjacency::SipIdentity sip [1]

other end: perimeta::adjacency::SipIdentity.traffic_group [0:*]

relation perimeta::adjacency::SipTrafficGroupCallMediaPolicyIdentity call_media_policy [0:1]

other end: perimeta::adjacency::SipTrafficGroupCallMediaPolicyIdentity.sip_traffic_group [1]

relation perimeta::adjacency::SipTrafficGroupCallLimitsIdentity call_limits [0:1]

other end: perimeta::adjacency::SipTrafficGroupCallLimitsIdentity.sip_traffic_group [1]

relation perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsIdentity traffic_group_limits [0:*]

other end: perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsIdentity.sip_traffic_group [1]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_uri constraint true

entity perimeta::adjacency::SipTrafficGroupTrafficGroupLimits

Parents: perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsIdentity, std::PurgeableResource

Inmanta resource to manage a /adjacency/sip/traffic-group/traffic-group-limits Perimeta API resource.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_appearances_t? call_appearances=null

Specifies the maximum number of concurrent calls permitted for this traffic group. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute bool? call_appearances_use_default=null

Specifies the maximum number of concurrent calls permitted for this traffic group. This includes both incoming and outgoing calls. Note that a single call may involve the Session Controller processing more than one call setup message; for example, two are required for authentication.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_registrations_t? registrations=null

Sets a maximum number of concurrent registrations for this traffic group.

attribute bool? registrations_use_default=null

Sets a maximum number of concurrent registrations for this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_media_streams_t? media_streams=null

Sets the maximum number of media streams used by this traffic group at any one time.

attribute bool? media_streams_use_default=null

Sets the maximum number of media streams used by this traffic group at any one time.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_t? call_setup_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which call setup messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_value_t? call_setup_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_sustain_units_t? call_setup_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_t? call_setup_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this traffic group.

attribute bool? call_setup_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_value_t? call_setup_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_call_setup_rate_max_burst_units_t? call_setup_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_t? in_call_message_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which in-call signaling messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_value_t? in_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_sustain_units_t? in_call_message_rate_max_sustain_units=null

Rate limit units (messages/time-period)

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_t? in_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this traffic group.

attribute bool? in_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which in-call signaling messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_value_t? in_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the in-call-message-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_in_call_message_rate_max_burst_units_t? in_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_t? out_of_call_message_rate_max_sustain=null

Specifies whether there is a limit on the sustain limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_value_t? out_of_call_message_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_sustain_units_t? out_of_call_message_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_t? out_of_call_message_rate_max_burst=null

Specifies whether there is a limit on the maximum burst limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute bool? out_of_call_message_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst limit at which out-of-call signaling messages can be sent to or from this traffic group.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_value_t? out_of_call_message_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the out-of-call-message-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_out_of_call_message_rate_max_burst_units_t? out_of_call_message_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_t? regs_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate of registrations including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_value_t? regs_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-sustain-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_sustain_units_t? regs_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_t? regs_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute bool? regs_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate of registrations (including re-registrations) from this adjacency. This excludes the additional REGISTER messages triggered by Perimeta’s fast-registration feature (which are not passed on the registrar). It also excludes de-registrations (REGISTER messages with an expiry time of 0).

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_value_t? regs_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the regs-rate-max-burst-units Property.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_regs_rate_max_burst_units_t? regs_rate_max_burst_units=null

Specifies the measurement unit in which the maximum burst rate is given.

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_max_bandwidth_t? max_bandwidth=null

Sets a maximum for the amount of bandwidth used by this traffic group at any one time.

attribute bool? max_bandwidth_use_default=null

Sets a maximum for the amount of bandwidth used by this traffic group at any one time.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_traffic_group_limits_config

• perimeta::adjacency::sip_traffic_group_traffic_group_limits_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_traffic_group_limits_config, perimeta::adjacency::sip_traffic_group_traffic_group_limits_cross_device_relations constraint true

entity perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /adjacency/sip/traffic-group/traffic-group-limits Perimeta API resource. Abstract base entity. For concrete usage, see children SipTrafficGroupTrafficGroupLimits and SipTrafficGroupTrafficGroupLimitsUnmanaged.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

attribute perimeta::adjacency::sip_traffic_group_traffic_group_limits_direction_t direction

Apply limits directionally

relation perimeta::adjacency::SipTrafficGroupIdentity sip_traffic_group [1]

other end: perimeta::adjacency::SipTrafficGroupIdentity.traffic_group_limits [0:*]

The following implementations are defined for this entity:

• perimeta::adjacency::sip_traffic_group_traffic_group_limits_uri

The following implements statements select implementations for this entity:

• perimeta::adjacency::sip_traffic_group_traffic_group_limits_uri constraint true

entity perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsUnmanaged

Parents: perimeta::adjacency::SipTrafficGroupTrafficGroupLimitsIdentity

Unmanaged reference to a /adjacency/sip/traffic-group/traffic-group-limits Perimeta API resource.

Configuration mode for capacity control limts applying to this traffic group as a whole, rather than to individual calls involving it. You can also apply directional limits by adding one of the parameters as-source and as-destination . For more information, see Capacity control limits in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/CapacityControlLimits.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipTrafficGroupUnmanaged

Parents: perimeta::adjacency::SipTrafficGroupIdentity

Unmanaged reference to a /adjacency/sip/traffic-group Perimeta API resource.

Creates a traffic group on this adjacency or edits an existing traffic group. You can use a traffic group to apply capacity control and call media policies to some of the traffic passing through this adjacency, based on the properties of each call or non-call message (e.g. REGISTER or other out-of-dialog message). You can also configure SIP privacy or set a media location.

Once you have created a traffic group, you must apply it using routing or the SIP Message Manipulation Framework. For more information, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::adjacency::SipUnmanaged

Parents: perimeta::adjacency::SipIdentity

Unmanaged reference to a /adjacency/sip Perimeta API resource.

Configuration mode for a SIP adjacency (a SIP interface used by the Session Controller on a particular service network). For more information, see Adjacencies in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/Adjacencies.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ca_public_certificate_store::CaCertificate

Parents: perimeta::ca_public_certificate_store::CaCertificateIdentity, std::PurgeableResource

Inmanta resource to manage a /ca-public-certificate-store/ca-certificate Perimeta API resource.

Imports the public certificate of a certification authority, which the Session Controller uses to validate the signed certificates of TLS peers. The certificate must be encoded in base64 and should include the header and footer. For more information, see Importing the public certificate of a certification authority in Perimeta Configuration And Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ImportingThePublicCertificateOfACertificationAuthority.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::ca_public_certificate_store::ca_certificate_ca_certificate_t ca_certificate

Body of the CA certificate. You can enter the certificate over multiple lines.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ca_public_certificate_store::ca_certificate_config

• perimeta::ca_public_certificate_store::ca_certificate_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ca_public_certificate_store::ca_certificate_config, perimeta::ca_public_certificate_store::ca_certificate_cross_device_relations constraint true

entity perimeta::ca_public_certificate_store::CaCertificateIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ca-public-certificate-store/ca-certificate Perimeta API resource. Abstract base entity. For concrete usage, see children CaCertificate and CaCertificateUnmanaged.

Imports the public certificate of a certification authority, which the Session Controller uses to validate the signed certificates of TLS peers. The certificate must be encoded in base64 and should include the header and footer. For more information, see Importing the public certificate of a certification authority in Perimeta Configuration And Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ImportingThePublicCertificateOfACertificationAuthority.html).

attribute perimeta::ca_public_certificate_store::ca_certificate_ca_cert_name_t ca_cert_name

A short string to identify the CA certificate. This must only contain alphanumeric characters.

relation perimeta::ca_public_certificate_store::CaPublicCertificateStoreIdentity ca_public_certificate_store [1]

other end: perimeta::ca_public_certificate_store::CaPublicCertificateStoreIdentity.ca_certificate [0:*]

The following implementations are defined for this entity:

• perimeta::ca_public_certificate_store::ca_certificate_uri

The following implements statements select implementations for this entity:

• perimeta::ca_public_certificate_store::ca_certificate_uri constraint true

entity perimeta::ca_public_certificate_store::CaCertificateUnmanaged

Parents: perimeta::ca_public_certificate_store::CaCertificateIdentity

Unmanaged reference to a /ca-public-certificate-store/ca-certificate Perimeta API resource.

Imports the public certificate of a certification authority, which the Session Controller uses to validate the signed certificates of TLS peers. The certificate must be encoded in base64 and should include the header and footer. For more information, see Importing the public certificate of a certification authority in Perimeta Configuration And Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ImportingThePublicCertificateOfACertificationAuthority.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ca_public_certificate_store::CaPublicCertificateStore

Parents: perimeta::ca_public_certificate_store::CaPublicCertificateStoreIdentity, std::PurgeableResource

Inmanta resource to manage a /ca-public-certificate-store Perimeta API resource.

Stores a set of certification authority public certificates, which the Session Controller uses to validate the signed certificates of TLS peers. Stores other than ‘default’ are only used if configured on an adjacency.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ca_public_certificate_store::ca_public_certificate_store_config

• perimeta::ca_public_certificate_store::ca_public_certificate_store_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ca_public_certificate_store::ca_public_certificate_store_config, perimeta::ca_public_certificate_store::ca_public_certificate_store_cross_device_relations constraint true

entity perimeta::ca_public_certificate_store::CaPublicCertificateStoreIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ca-public-certificate-store Perimeta API resource. Abstract base entity. For concrete usage, see children CaPublicCertificateStore and CaPublicCertificateStoreUnmanaged.

Stores a set of certification authority public certificates, which the Session Controller uses to validate the signed certificates of TLS peers. Stores other than ‘default’ are only used if configured on an adjacency.

attribute perimeta::ca_public_certificate_store::ca_public_certificate_store_ca_cert_store_name_t ca_cert_store_name

A short string to identify the CA certificate store. This must only contain alphanumeric characters.

relation perimeta::ca_public_certificate_store::CaCertificateIdentity ca_certificate [0:*]

other end: perimeta::ca_public_certificate_store::CaCertificateIdentity.ca_public_certificate_store [1]

The following implementations are defined for this entity:

• perimeta::ca_public_certificate_store::ca_public_certificate_store_uri

The following implements statements select implementations for this entity:

• perimeta::ca_public_certificate_store::ca_public_certificate_store_uri constraint true

entity perimeta::ca_public_certificate_store::CaPublicCertificateStoreUnmanaged

Parents: perimeta::ca_public_certificate_store::CaPublicCertificateStoreIdentity

Unmanaged reference to a /ca-public-certificate-store Perimeta API resource.

Stores a set of certification authority public certificates, which the Session Controller uses to validate the signed certificates of TLS peers. Stores other than ‘default’ are only used if configured on an adjacency.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::call_policy_set::CallPolicySet

Parents: perimeta::call_policy_set::CallPolicySetIdentity, std::PurgeableResource

Inmanta resource to manage a /call-policy-set Perimeta API resource.

Configuration mode for a call policy set, specified by a policy set ID, which is a positive integer. You can use this mode to configure tables for routing policy. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html). For information on how to configure a call policy set, see Configuring a call policy set in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACallPolicySet.html).

You can create a copy of a call policy set by including a MSW-Copy-Recursive header specifying the index of the call policy set to copy in requests to create a new call policy set Resource. For more information, see Accessing Resources using HTTP methods and headers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/RESTAPIGuide/Source/Perimeta/References/AccessingResourcesUsingHTTPActionsAndHeaders.html).

Creating a copy of a call policy set may have a temporary service impact, especially for call policy sets with more than 500 child Resources. Because of this:

• Metaswitch recommends that you copy call policy sets with more than 500 child Resources during a maintenance window.

• You cannot use the MSW-Copy-Recursive header to copy a call policy set if this would result in more than 15 call policy sets on your Session Controller. This prevents repeated copying having an impact on your service.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::call_policy_set::call_policy_set_description_t? description=null

Sets a description for this call policy set. The description is used only for clarity when viewing information about the call policy set.

attribute bool? complete=null

Completes the call policy set and makes it available for use as the active call policy set.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel first_call_routing_table: Sets the first routing table to apply to dialog-creating and out-of-dialog requests. For new call requests, this takes place after number analysis has been completed (if the call has not been rejected). :rel first_reg_routing_table: Sets the first routing policy table to apply to registration requests (REGISTERs). :rel first_ecn_routing_table: Sets the first routing policy table to apply to emergency call notifications.

relation perimeta::call_policy_set::RoutingTableIdentity first_call_routing_table [0:1]

Sets the first routing table to apply to dialog-creating and out-of-dialog requests. For new call requests, this takes

place after number analysis has been completed (if the call has not been rejected).

Peer relation:

relation perimeta::call_policy_set::RoutingTableIdentity first_reg_routing_table [0:1]

Sets the first routing policy table to apply to registration requests (REGISTERs). Peer relation:

relation perimeta::call_policy_set::RoutingTableIdentity first_ecn_routing_table [0:1]

Sets the first routing policy table to apply to emergency call notifications. Peer relation:

The following implementations are defined for this entity:

• perimeta::call_policy_set::call_policy_set_config

• perimeta::call_policy_set::call_policy_set_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::call_policy_set_config, perimeta::call_policy_set::call_policy_set_cross_device_relations constraint true

entity perimeta::call_policy_set::CallPolicySetIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /call-policy-set Perimeta API resource. Abstract base entity. For concrete usage, see children CallPolicySet and CallPolicySetUnmanaged.

Configuration mode for a call policy set, specified by a policy set ID, which is a positive integer. You can use this mode to configure tables for routing policy. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html). For information on how to configure a call policy set, see Configuring a call policy set in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACallPolicySet.html).

You can create a copy of a call policy set by including a MSW-Copy-Recursive header specifying the index of the call policy set to copy in requests to create a new call policy set Resource. For more information, see Accessing Resources using HTTP methods and headers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/RESTAPIGuide/Source/Perimeta/References/AccessingResourcesUsingHTTPActionsAndHeaders.html).

Creating a copy of a call policy set may have a temporary service impact, especially for call policy sets with more than 500 child Resources. Because of this:

• Metaswitch recommends that you copy call policy sets with more than 500 child Resources during a maintenance window.

• You cannot use the MSW-Copy-Recursive header to copy a call policy set if this would result in more than 15 call policy sets on your Session Controller. This prevents repeated copying having an impact on your service.

attribute perimeta::call_policy_set::call_policy_set_call_policy_set_t call_policy_set

The call policy set ID.

relation perimeta::call_policy_set::RoutingTableIdentity routing_table [0:*]

other end: perimeta::call_policy_set::RoutingTableIdentity.call_policy_set [1]

The following implementations are defined for this entity:

• perimeta::call_policy_set::call_policy_set_uri

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::call_policy_set_uri constraint true

entity perimeta::call_policy_set::CallPolicySetUnmanaged

Parents: perimeta::call_policy_set::CallPolicySetIdentity

Unmanaged reference to a /call-policy-set Perimeta API resource.

Configuration mode for a call policy set, specified by a policy set ID, which is a positive integer. You can use this mode to configure tables for routing policy. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html). For information on how to configure a call policy set, see Configuring a call policy set in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACallPolicySet.html).

You can create a copy of a call policy set by including a MSW-Copy-Recursive header specifying the index of the call policy set to copy in requests to create a new call policy set Resource. For more information, see Accessing Resources using HTTP methods and headers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/RESTAPIGuide/Source/Perimeta/References/AccessingResourcesUsingHTTPActionsAndHeaders.html).

Creating a copy of a call policy set may have a temporary service impact, especially for call policy sets with more than 500 child Resources. Because of this:

• Metaswitch recommends that you copy call policy sets with more than 500 child Resources during a maintenance window.

• You cannot use the MSW-Copy-Recursive header to copy a call policy set if this would result in more than 15 call policy sets on your Session Controller. This prevents repeated copying having an impact on your service.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::call_policy_set::RoutingTable

Parents: perimeta::call_policy_set::RoutingTableIdentity, std::PurgeableResource

Inmanta resource to manage a /call-policy-set/routing-table Perimeta API resource.

Configuration mode for a routing table. The Session Controller’s call policy set consists of a set of routing tables. The Session Controller consults these tables to determine the routing action it must take when it receives a new call or subscriber regiatsration request. Each routing table contains one or more entries that specify a particular feature of a SIP request and the action the Session Controller must take if it finds a match for this feature. These actions include consulting another table, which allows you to configure complex routing policy that takes multiple features of the request into account.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::call_policy_set::routing_table_description_t? description=null

Sets a text description for this routing table.

attribute perimeta::call_policy_set::routing_table_type_t type

Specifies the routing table type. The routing table type determines the feature of a SIP request on which entries in the routing table will match. For example, entries in a routing table with the destination-domain type will match on the destination domain of the request being routed. This Property is visible on both routing-table Resources and entry Resources. You can edit this Property on a routing-table Resource. It is read-only on an entry Resource and simply informs you of the routing table type used by the parent routing-table Resource.

attribute perimeta::call_policy_set::routing_table_metric_t? metric=null

Specifies the QoS metric on which the Session Controller must base routing decisions for this table.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::call_policy_set::routing_table_config

• perimeta::call_policy_set::routing_table_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::routing_table_config, perimeta::call_policy_set::routing_table_cross_device_relations constraint true

entity perimeta::call_policy_set::RoutingTableEntry

Parents: perimeta::call_policy_set::RoutingTableEntryIdentity, std::PurgeableResource

Inmanta resource to manage a /call-policy-set/routing-table/entry Perimeta API resource.

Configuration mode for a single entry in the current table. The entry is specified by a numerical index.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::call_policy_set::routing_table_entry_route_on_cost_t? route_on_cost=null

Specifies whether this entry will be assigned a cost value or if it should never by matched by the Session Controller.

attribute perimeta::call_policy_set::routing_table_entry_cost_t? cost=null

Sets a cost for this entry. The Session Controller will select the valid entry with the lowest cost when using a least-cost routing table.

attribute perimeta::call_policy_set::routing_table_entry_weight_t? weight=null

Assign a weight to this entry. The Session Contoller will select between equally valid entries in a table using probabilities based on the ratios of the weights of the entries.

attribute perimeta::call_policy_set::routing_table_entry_match_account_t? match_account=null

Determines whether this entry will match against a specific account or any account.

attribute perimeta::call_policy_set::routing_table_entry_match_adjacency_t? match_adjacency=null

Determines whether this entry will match against a specific adjacency or any adjacency.

attribute perimeta::call_policy_set::routing_table_entry_match_category_t? match_category=null

Determines whether this entry will match against a specific category or if it will match any call. If you want this entry to match against a custom category, you must set this Property to custom-category and then set the category-to-match Property to the name of your chosen custom category.

attribute perimeta::call_policy_set::routing_table_entry_category_to_match_t? category_to_match=null

Specifies the custom category against which this entry will match. Specify a string between 0 and 19 alphanumeric characters in length. This must not include cat.custom.

attribute perimeta::call_policy_set::routing_table_entry_match_cic_t? match_cic=null

Determines whether this entry will match against the absence of a carrier identification code (CIC), the presence of any CIC or the presence of a specific CIC.

attribute perimeta::call_policy_set::routing_table_entry_cic_to_match_t? cic_to_match=null

Specifies the carrier identification code (CIC) against which this entry will match. This must be a string between 3 and 4 hexadecimal characters.

attribute perimeta::call_policy_set::routing_table_entry_match_domain_t? match_domain=null

Specifies the domain name against which this entry will match. This can either be a specific domain name or a regular expression.

attribute bool? match_domain_using_regex=null

Specifies that the domain against which this entry must match is given as a regular expression.

attribute perimeta::call_policy_set::routing_table_entry_match_id_match_type_t? match_id_match_type=null

Determines whether the ID that this entry will match against is given as a destination number or a text username.

attribute perimeta::call_policy_set::routing_table_entry_match_id_regex_to_match_t? match_id_regex_to_match=null

Specifies the text username against which this entry will match as a regular expression.

attribute perimeta::call_policy_set::routing_table_entry_match_id_digits_to_match_t? match_id_digits_to_match=null

Specifies the destination number against which thjis entry will match against. This must be a string with the syntax described in Syntax of number matching strings in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/SyntaxOfNumberMatchingStrings.html) and can include the letters A-F and #, + and * characters, as well as digits.

attribute bool? match_id_on_prefix=null

Marks the string provided in the match-id-digits-to-match Property as a prefix string. This entry will be matched if any prefix of the number or username matches the string.

attribute perimeta::call_policy_set::routing_table_entry_match_tgid_t? match_tgid=null

Specifies that this entry will match against a trunk group ID or trunk group ID and context.

attribute perimeta::call_policy_set::routing_table_entry_context_t? context=null

Specifies the trunk group ID context against which this entry will match.

attribute perimeta::call_policy_set::routing_table_entry_tgid_t? tgid=null

Specifies the trunk group ID against which this entry will match.

attribute perimeta::call_policy_set::routing_table_entry_desirable_threshold_t? desirable_threshold=null

Specifies the average QoS metric at and above which voice quality is of an acceptable level.

attribute perimeta::call_policy_set::routing_table_entry_unacceptable_threshold_t? unacceptable_threshold=null

Specifies the average QoS metric value below which voice quality is no longer of an acceptable level.

attribute bool? apply_destination_number_manipulation=null

Specifies whether to make changes to the destination number of the new call request when this entry is selected.

attribute perimeta::call_policy_set::routing_table_entry_destination_number_manipulation_rule_t? destination_number_manipulation_rule=null

Specifies changes to make to the destination number of the new call request when this entry is selected. For information on how to construct the string specifying the changes, see Syntax of number editing strings in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/SyntaxOfNumberEditingStrings.html).

attribute bool? apply_source_number_manipulation=null

Specifies whether to make changes to the source number of the new call request when this entry is selected.

attribute perimeta::call_policy_set::routing_table_entry_source_number_manipulation_rule_t? source_number_manipulation_rule=null

Specifies changes to make to the source number of the new call request when this entry is selected. For information on how to construct the string specifying the changes, see Syntax of number editing strings in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/SyntaxOfNumberEditingStrings.html).

attribute perimeta::call_policy_set::routing_table_entry_destination_tgid_manipulation_t? destination_tgid_manipulation=null

Specifies changes to make to the destination trunk group ID and context when this entry is selected. You can strip them or replace them with a new ID and context. For more information on trunk group editing, see Trunk groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrunkGroups.html).

attribute perimeta::call_policy_set::routing_table_entry_new_dest_context_t? new_dest_context=null

Trunk group ID context

attribute perimeta::call_policy_set::routing_table_entry_new_dest_tgid_t? new_dest_tgid=null

Trunk group ID

attribute perimeta::call_policy_set::routing_table_entry_source_tgid_manipulation_t? source_tgid_manipulation=null

Specifies changes to make to the source trunk group ID and context when this entry is selected. You can strip them or replace them with a new ID and context. For more information on trunk group editing, see Trunk groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrunkGroups.html).

attribute perimeta::call_policy_set::routing_table_entry_new_src_context_t? new_src_context=null

Trunk group ID context

attribute perimeta::call_policy_set::routing_table_entry_new_src_tgid_t? new_src_tgid=null

Trunk group ID

attribute bool? apply_traffic_group=null

Specifies whether to add a traffic group to the call if this entry is selected. For more information on traffic groups, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

attribute perimeta::call_policy_set::routing_table_entry_traffic_group_to_apply_t? traffic_group_to_apply=null

Specifies a traffic group to add if this entry is selected. Specify a string of up to 22 alphanumeric characters. This must be the name of a traffic group already configured on the Session Controller. For more information on traffic groups, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html).

attribute perimeta::call_policy_set::routing_table_entry_action_t action

Specifies the next action that the Session Controller should take when this entry is selected.

attribute perimeta::call_policy_set::routing_table_entry_dynamic_peer_routing_t? dynamic_peer_routing=null

Specifies whether dynamic domain routing is enabled for this entry. If dynamic peer routing is enabled and the Session Controller matches this entry, the Session Controller searches for an adjacency that has a dynamic routing match-domain (or signaling peer if no dynamic routing match-domain is configured) matching the destination domain of the message, and sets that adjacency as the destination.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel account_to_match: Specifies the account against which this entry will match. :rel adjacency_to_match: Specifies the adjacency against which this entry will match. :rel next_table: Specifies the name of the next routing table. The Session Controller will go on to consult this table after selecting this entry. :rel destination_sip_adjacency: Name of destination adjacency :rel destination_adjacency: Sets the destination adjacency the Session Controller should route the request to if this entry is selected. This will be overridden if another table entry with this field set is selected before the routing action is completed.

relation perimeta::account::AccountIdentity account_to_match [0:1]

Specifies the account against which this entry will match. Peer relation:

relation perimeta::adjacency::SipIdentity adjacency_to_match [0:1]

Specifies the adjacency against which this entry will match. Peer relation:

relation perimeta::call_policy_set::RoutingTableIdentity next_table [0:1]

Specifies the name of the next routing table. The Session Controller will go on to consult this table after selecting

this entry.

Peer relation:

relation perimeta::adjacency::SipIdentity destination_sip_adjacency [0:1]

Name of destination adjacency Peer relation:

relation perimeta::adjacency::SipIdentity destination_adjacency [0:1]

Sets the destination adjacency the Session Controller should route the request to if this entry is selected. This will

be overridden if another table entry with this field set is selected before the routing action is completed.

Peer relation:

The following implementations are defined for this entity:

• perimeta::call_policy_set::routing_table_entry_config

• perimeta::call_policy_set::routing_table_entry_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::routing_table_entry_config, perimeta::call_policy_set::routing_table_entry_cross_device_relations constraint true

entity perimeta::call_policy_set::RoutingTableEntryIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /call-policy-set/routing-table/entry Perimeta API resource. Abstract base entity. For concrete usage, see children RoutingTableEntry and RoutingTableEntryUnmanaged.

Configuration mode for a single entry in the current table. The entry is specified by a numerical index.

attribute perimeta::call_policy_set::routing_table_entry_entry_t entry

The index that identifies the table entry. This is a positive integer.

relation perimeta::call_policy_set::RoutingTableIdentity routing_table [1]

other end: perimeta::call_policy_set::RoutingTableIdentity.entry [0:*]

The following implementations are defined for this entity:

• perimeta::call_policy_set::routing_table_entry_uri

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::routing_table_entry_uri constraint true

entity perimeta::call_policy_set::RoutingTableEntryUnmanaged

Parents: perimeta::call_policy_set::RoutingTableEntryIdentity

Unmanaged reference to a /call-policy-set/routing-table/entry Perimeta API resource.

Configuration mode for a single entry in the current table. The entry is specified by a numerical index.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::call_policy_set::RoutingTableIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /call-policy-set/routing-table Perimeta API resource. Abstract base entity. For concrete usage, see children RoutingTable and RoutingTableUnmanaged.

Configuration mode for a routing table. The Session Controller’s call policy set consists of a set of routing tables. The Session Controller consults these tables to determine the routing action it must take when it receives a new call or subscriber regiatsration request. Each routing table contains one or more entries that specify a particular feature of a SIP request and the action the Session Controller must take if it finds a match for this feature. These actions include consulting another table, which allows you to configure complex routing policy that takes multiple features of the request into account.

attribute perimeta::call_policy_set::routing_table_name_t name

Sets a name for the routing table

relation perimeta::call_policy_set::CallPolicySetIdentity call_policy_set [1]

other end: perimeta::call_policy_set::CallPolicySetIdentity.routing_table [0:*]

relation perimeta::call_policy_set::RoutingTableEntryIdentity entry [0:*]

other end: perimeta::call_policy_set::RoutingTableEntryIdentity.routing_table [1]

The following implementations are defined for this entity:

• perimeta::call_policy_set::routing_table_uri

The following implements statements select implementations for this entity:

• perimeta::call_policy_set::routing_table_uri constraint true

entity perimeta::call_policy_set::RoutingTableUnmanaged

Parents: perimeta::call_policy_set::RoutingTableIdentity

Unmanaged reference to a /call-policy-set/routing-table Perimeta API resource.

Configuration mode for a routing table. The Session Controller’s call policy set consists of a set of routing tables. The Session Controller consults these tables to determine the routing action it must take when it receives a new call or subscriber regiatsration request. Each routing table contains one or more entries that specify a particular feature of a SIP request and the action the Session Controller must take if it finds a match for this feature. These actions include consulting another table, which allows you to configure complex routing policy that takes multiple features of the request into account.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::called_number::CalledNumber

Parents: perimeta::called_number::CalledNumberIdentity, std::PurgeableResource

Inmanta resource to manage a /called-number Perimeta API resource.

Configuration mode for a called-number. The capacity control limits must be configured using a child called-number-limits Resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::called_number::called_number_call_setup_rate_max_sustain_t? call_setup_rate_max_sustain=null

Specifies whether there is a limit on the maximum sustain rate at which call setup messages can be sent to this called number.

attribute perimeta::called_number::called_number_call_setup_rate_max_sustain_value_t? call_setup_rate_max_sustain_value=null

Specifies the maximum sustain rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-sustain-units Property.

attribute perimeta::called_number::called_number_call_setup_rate_max_sustain_units_t? call_setup_rate_max_sustain_units=null

Specifies the measurement unit in which the maximum sustain rate is given.

attribute perimeta::called_number::called_number_call_setup_rate_max_burst_t? call_setup_rate_max_burst=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to this called number.

attribute bool? call_setup_rate_max_burst_use_default=null

Specifies whether there is a limit on the maximum burst rate at which call setup messages can be sent to this called number.

attribute perimeta::called_number::called_number_call_setup_rate_max_burst_value_t? call_setup_rate_max_burst_value=null

Specifies the maximum burst rate in either messages per minute or messages per second, depending on the unit specified using the call-setup-rate-max-burst-units Property.

attribute perimeta::called_number::called_number_call_setup_rate_max_burst_units_t? call_setup_rate_max_burst_units=null

Rate limit units (messages/time-period)

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::called_number::called_number_config

• perimeta::called_number::called_number_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::called_number::called_number_config, perimeta::called_number::called_number_cross_device_relations constraint true

entity perimeta::called_number::CalledNumberIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /called-number Perimeta API resource. Abstract base entity. For concrete usage, see children CalledNumber and CalledNumberUnmanaged.

Configuration mode for a called-number. The capacity control limits must be configured using a child called-number-limits Resource.

attribute perimeta::called_number::called_number_called_number_t called_number

Called number

The following implementations are defined for this entity:

• perimeta::called_number::called_number_uri

The following implements statements select implementations for this entity:

• perimeta::called_number::called_number_uri constraint true

entity perimeta::called_number::CalledNumberUnmanaged

Parents: perimeta::called_number::CalledNumberIdentity

Unmanaged reference to a /called-number Perimeta API resource.

Configuration mode for a called-number. The capacity control limits must be configured using a child called-number-limits Resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::codec_list::CodecList

Parents: perimeta::codec_list::CodecListIdentity, std::PurgeableResource

Inmanta resource to manage a /codec-list Perimeta API resource.

This Resource represents a codec list configured on the Session Controller. You can use codec lists to control the use of codecs in calls passing through the Session Controller. You can apply lists to particular accounts or adjacencies, either as a codec allowlist or as a codec preference list.

• A codec allowlist allows you to control which codecs can be used in a call. By default, all supported codecs are permitted. If you specify an allowlist for an account or adjacency, the permitted codecs for calls involving that account or adjacency are limited to those on the list. When an allowlist is in effect during call setup, the Session Controller will strip any codecs that are not on the list from the SDP offer and answer, preventing them from being used in the call.

• A codec preference list allows you to control the order in which codecs are listed in an SDP offer, which will usually determine the priority order in which endpoints select which codecs to use. This allows you to encourage the use of particular codecs and discourage the use of others for calls involving particular accounts or adjacencies, without going as far as prohibiting the codecs you want to discourage use of. When a codec preference list is in effect during call setup, the Session Controller will rewrite the SDP it forwards to match the preference order given in the list.

Once you have created and configured a codec-list Resource, you can add one or more entries to it by creating entry Resources. Each entry represents a codec that will be included in the codec list. If this codec list will be used as a codec preference list, you can also assign priority values to each entry. When you have added all of the required entries to the codec list, you can apply it to an account or adjacency using the supported-codecs or preferred-codecs Properties on the call-media-policy Resource of your chosen account or adjacency, depending on whether you want the codec list to be used as a codec allowlist or codec preference list.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::codec_list::codec_list_description_t? description=null

Sets a description for the codec list.

attribute perimeta::codec_list::codec_list_default_priority_for_sd_t? default_priority_for_sd=null

Sets the passthrough priority for standard definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute perimeta::codec_list::codec_list_default_transcoding_priority_for_sd_t? default_transcoding_priority_for_sd=null

Sets the transcoding priority for standard definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute bool? default_transcoding_priority_for_sd_use_default=null

Sets the transcoding priority for standard definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute perimeta::codec_list::codec_list_default_priority_for_hd_t? default_priority_for_hd=null

Sets the passthrough priority for high definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute perimeta::codec_list::codec_list_default_transcoding_priority_for_hd_t? default_transcoding_priority_for_hd=null

Sets the transcoding priority for high definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute bool? default_transcoding_priority_for_hd_use_default=null

Sets the transcoding priority for high definition codecs in the codec list that do not have a priority explicitly configured and codecs that are not included in the list on the basis of the codec’s fidelity.

attribute perimeta::codec_list::codec_list_tc_cross_fidelity_penalty_t? tc_cross_fidelity_penalty=null

Sets a cross-fidelity penalty for codecs that are inserted by transcoding and do not have a fidelity (standard definition (SD) or high definition (HD)) matching the fidelity of any codec in the inbound offer. This penalty is added to the priority value for the codec. It only applies when the inbound offer contains only SD or HD codecs (not both). You must set this on a codec list used as a codec preference list on the callee’s side of the call. You can use this to discourage the callee from choosing a codec that would cause SD-to-HD or HD-to-SD transcoding. These combinations use more resources than SD-to-SD transcoding and provide worse call quality than HD-to-HD transcoding. For more information, see Matching codec fidelities in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::codec_list::codec_list_config

• perimeta::codec_list::codec_list_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::codec_list::codec_list_config, perimeta::codec_list::codec_list_cross_device_relations constraint true

entity perimeta::codec_list::CodecListIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /codec-list Perimeta API resource. Abstract base entity. For concrete usage, see children CodecList and CodecListUnmanaged.

This Resource represents a codec list configured on the Session Controller. You can use codec lists to control the use of codecs in calls passing through the Session Controller. You can apply lists to particular accounts or adjacencies, either as a codec allowlist or as a codec preference list.

• A codec allowlist allows you to control which codecs can be used in a call. By default, all supported codecs are permitted. If you specify an allowlist for an account or adjacency, the permitted codecs for calls involving that account or adjacency are limited to those on the list. When an allowlist is in effect during call setup, the Session Controller will strip any codecs that are not on the list from the SDP offer and answer, preventing them from being used in the call.

• A codec preference list allows you to control the order in which codecs are listed in an SDP offer, which will usually determine the priority order in which endpoints select which codecs to use. This allows you to encourage the use of particular codecs and discourage the use of others for calls involving particular accounts or adjacencies, without going as far as prohibiting the codecs you want to discourage use of. When a codec preference list is in effect during call setup, the Session Controller will rewrite the SDP it forwards to match the preference order given in the list.

Once you have created and configured a codec-list Resource, you can add one or more entries to it by creating entry Resources. Each entry represents a codec that will be included in the codec list. If this codec list will be used as a codec preference list, you can also assign priority values to each entry. When you have added all of the required entries to the codec list, you can apply it to an account or adjacency using the supported-codecs or preferred-codecs Properties on the call-media-policy Resource of your chosen account or adjacency, depending on whether you want the codec list to be used as a codec allowlist or codec preference list.

attribute perimeta::codec_list::codec_list_codec_list_name_t codec_list_name

Sets the name of the codec list.

relation perimeta::codec_list::EntryIdentity entry [0:*]

other end: perimeta::codec_list::EntryIdentity.codec_list [1]

The following implementations are defined for this entity:

• perimeta::codec_list::codec_list_uri

The following implements statements select implementations for this entity:

• perimeta::codec_list::codec_list_uri constraint true

entity perimeta::codec_list::CodecListUnmanaged

Parents: perimeta::codec_list::CodecListIdentity

Unmanaged reference to a /codec-list Perimeta API resource.

This Resource represents a codec list configured on the Session Controller. You can use codec lists to control the use of codecs in calls passing through the Session Controller. You can apply lists to particular accounts or adjacencies, either as a codec allowlist or as a codec preference list.

• A codec allowlist allows you to control which codecs can be used in a call. By default, all supported codecs are permitted. If you specify an allowlist for an account or adjacency, the permitted codecs for calls involving that account or adjacency are limited to those on the list. When an allowlist is in effect during call setup, the Session Controller will strip any codecs that are not on the list from the SDP offer and answer, preventing them from being used in the call.

• A codec preference list allows you to control the order in which codecs are listed in an SDP offer, which will usually determine the priority order in which endpoints select which codecs to use. This allows you to encourage the use of particular codecs and discourage the use of others for calls involving particular accounts or adjacencies, without going as far as prohibiting the codecs you want to discourage use of. When a codec preference list is in effect during call setup, the Session Controller will rewrite the SDP it forwards to match the preference order given in the list.

Once you have created and configured a codec-list Resource, you can add one or more entries to it by creating entry Resources. Each entry represents a codec that will be included in the codec list. If this codec list will be used as a codec preference list, you can also assign priority values to each entry. When you have added all of the required entries to the codec list, you can apply it to an account or adjacency using the supported-codecs or preferred-codecs Properties on the call-media-policy Resource of your chosen account or adjacency, depending on whether you want the codec list to be used as a codec allowlist or codec preference list.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::codec_list::Entry

Parents: perimeta::codec_list::EntryIdentity, std::PurgeableResource

Inmanta resource to manage a /codec-list/entry Perimeta API resource.

Specifies a codec in a codec list. The codec name must be the name used by the Session Controller for a codec that is configured on the system. This can be one of the pre-configured codecs or a custom codec. You can optionally specify passthrough and transcoding priority values (if the list will be used as a codec preference list) and a clock rate. For a codec preference list, the highest priority codec should have the lowest priority value. For more information on configuring codec lists, see Configuring a codec list in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACodecList.html). For a list of the pre-configured codecs, see Media codecs in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/MediaCodecs.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::codec_list::entry_preferred_payload_type_t? preferred_payload_type=null

Specifies an RTP payload type to use with this codec. The Session Controller will use the specified payload type on one side of a call if the codec list is applied as an RTP payload type preference list on a corresponding adjacency, account or traffic group. For more information, see RTP payload type interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPPayloadTypeInterworking.html). This basic command corresponds to the Preferred payload type field on the Codec List Entry object in MetaView Explorer and MetaView Web.

attribute bool? preferred_payload_type_use_default=null

Specifies an RTP payload type to use with this codec. The Session Controller will use the specified payload type on one side of a call if the codec list is applied as an RTP payload type preference list on a corresponding adjacency, account or traffic group. For more information, see RTP payload type interworking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RTPPayloadTypeInterworking.html). This basic command corresponds to the Preferred payload type field on the Codec List Entry object in MetaView Explorer and MetaView Web.

attribute perimeta::codec_list::entry_passthrough_priority_t? passthrough_priority=null

Specifies the priority to attach to the codec when passed through or, if a transcoding priority is not configured, when inserted by transcoding. This is only necessary if the list will be used as a codec preference list. The highest priority codec should have the lowest value.

attribute bool? passthrough_priority_use_default=null

Specifies the priority to attach to the codec when passed through or, if a transcoding priority is not configured, when inserted by transcoding. This is only necessary if the list will be used as a codec preference list. The highest priority codec should have the lowest value.

attribute perimeta::codec_list::entry_transcoding_priority_t? transcoding_priority=null

Specifies the priority to attach to the codec when added by transcoding. This is only necessary if the list will be used as a codec preference list. The highest priority codec should have the lowest value.

attribute bool? transcoding_priority_use_default=null

Specifies the priority to attach to the codec when added by transcoding. This is only necessary if the list will be used as a codec preference list. The highest priority codec should have the lowest value.

attribute perimeta::codec_list::entry_nominal_msrp_bandwidth_t? nominal_msrp_bandwidth=null

Specifies a nominal bandwidth value (in bits/s) that will be assigned to each MSRP stream in capacity control. This applies only if this entry Resource will be used in a non-audio-video codec list.

attribute bool? nominal_msrp_bandwidth_use_default=null

Specifies a nominal bandwidth value (in bits/s) that will be assigned to each MSRP stream in capacity control. This applies only if this entry Resource will be used in a non-audio-video codec list.

attribute perimeta::codec_list::entry_transcoding_fmtp_line_t? transcoding_fmtp_line=null

Specifies an FMTP parameter line to include in the SDP when inserting this codec into an outbound transcoded offer. You can include multiple FMTP parameters in the line. For example, octet-align=1; mode-set=0,2,4,7. This setting can also be used in some circumstances to insert an FMTP parameter line into answers that the Session Controller modifies to use a codec from the original offer. For more information, see SDP attributes in Transcoding logic and negotiation in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/TranscodingLogicAndNegotiation.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::codec_list::entry_config

• perimeta::codec_list::entry_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::codec_list::entry_config, perimeta::codec_list::entry_cross_device_relations constraint true

entity perimeta::codec_list::EntryIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /codec-list/entry Perimeta API resource. Abstract base entity. For concrete usage, see children Entry and EntryUnmanaged.

Specifies a codec in a codec list. The codec name must be the name used by the Session Controller for a codec that is configured on the system. This can be one of the pre-configured codecs or a custom codec. You can optionally specify passthrough and transcoding priority values (if the list will be used as a codec preference list) and a clock rate. For a codec preference list, the highest priority codec should have the lowest priority value. For more information on configuring codec lists, see Configuring a codec list in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACodecList.html). For a list of the pre-configured codecs, see Media codecs in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/MediaCodecs.html).

attribute perimeta::codec_list::entry_codec_name_t codec_name

Specifies the name of the codec that will be used by this entry. This must be the name used by the Session Controller for a codec that is configured on the system. This can be one of the pre-configured codecs or a custom codec. You must omit any dots from the name of your chosen codec. For example, G.729 should be entered as g729.

relation perimeta::codec_list::CodecListIdentity codec_list [1]

other end: perimeta::codec_list::CodecListIdentity.entry [0:*]

The following implementations are defined for this entity:

• perimeta::codec_list::entry_uri

The following implements statements select implementations for this entity:

• perimeta::codec_list::entry_uri constraint true

entity perimeta::codec_list::EntryUnmanaged

Parents: perimeta::codec_list::EntryIdentity

Unmanaged reference to a /codec-list/entry Perimeta API resource.

Specifies a codec in a codec list. The codec name must be the name used by the Session Controller for a codec that is configured on the system. This can be one of the pre-configured codecs or a custom codec. You can optionally specify passthrough and transcoding priority values (if the list will be used as a codec preference list) and a clock rate. For a codec preference list, the highest priority codec should have the lowest priority value. For more information on configuring codec lists, see Configuring a codec list in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACodecList.html). For a list of the pre-configured codecs, see Media codecs in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/References/MediaCodecs.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::custom_codec::DynamicPayloadType

Parents: perimeta::custom_codec::DynamicPayloadTypeIdentity, std::PurgeableResource

Inmanta resource to manage a /custom-codec/dynamic-payload-type Perimeta API resource.

This Resource represents a custom codec with a dynamic payload type on the Session Controller. You can configure a dynamic-payload-type Resource to allow the Session Controller to support a codec with a dynamic payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a dynamic-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::custom_codec::dynamic_payload_type_codec_type_t codec_type

Sets the codec type.

attribute perimeta::custom_codec::dynamic_payload_type_media_type_t? media_type=null

Sets the media type for this custom codec.

attribute perimeta::custom_codec::dynamic_payload_type_required_bandwidth_t? required_bandwidth=null

Specifies the default bandwidth requirement for this custom codec in bits per second.

attribute perimeta::custom_codec::dynamic_payload_type_channels_t? channels=null

Sets the default number of channels.

attribute perimeta::custom_codec::dynamic_payload_type_fidelity_t? fidelity=null

Sets the fidelity for the custom codec. This can be either standard definition (SD) or high definition (HD).

attribute perimeta::custom_codec::dynamic_payload_type_max_frames_per_packet_t? max_frames_per_packet=null

Sets the default value for the maximum number of frames per packet.

attribute perimeta::custom_codec::dynamic_payload_type_packetization_time_t? packetization_time=null

Sets the packetization time for this custom codec in milliseconds.

attribute perimeta::custom_codec::dynamic_payload_type_clock_rate_t? clock_rate=null

Sets the default clock rate for this custom codec in hertz.

attribute perimeta::custom_codec::dynamic_payload_type_sample_size_per_channel_t? sample_size_per_channel=null

Sets the sample size per channel for this custom codec in bits.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::custom_codec::dynamic_payload_type_config

• perimeta::custom_codec::dynamic_payload_type_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::custom_codec::dynamic_payload_type_config, perimeta::custom_codec::dynamic_payload_type_cross_device_relations constraint true

entity perimeta::custom_codec::DynamicPayloadTypeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /custom-codec/dynamic-payload-type Perimeta API resource. Abstract base entity. For concrete usage, see children DynamicPayloadType and DynamicPayloadTypeUnmanaged.

This Resource represents a custom codec with a dynamic payload type on the Session Controller. You can configure a dynamic-payload-type Resource to allow the Session Controller to support a codec with a dynamic payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a dynamic-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

attribute perimeta::custom_codec::dynamic_payload_type_codec_name_t codec_name

Specifies the name of the codec. This must match the codec’s standard representation in SDP. Note that if you want to configure the SILK codec, you must use SILK/8000 for the narrowband codec or SILK/16000 for the wideband codec.

The following implementations are defined for this entity:

• perimeta::custom_codec::dynamic_payload_type_uri

The following implements statements select implementations for this entity:

• perimeta::custom_codec::dynamic_payload_type_uri constraint true

entity perimeta::custom_codec::DynamicPayloadTypeUnmanaged

Parents: perimeta::custom_codec::DynamicPayloadTypeIdentity

Unmanaged reference to a /custom-codec/dynamic-payload-type Perimeta API resource.

This Resource represents a custom codec with a dynamic payload type on the Session Controller. You can configure a dynamic-payload-type Resource to allow the Session Controller to support a codec with a dynamic payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a dynamic-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::custom_codec::StaticPayloadType

Parents: perimeta::custom_codec::StaticPayloadTypeIdentity, std::PurgeableResource

Inmanta resource to manage a /custom-codec/static-payload-type Perimeta API resource.

This Resource represents a custom codec with a static payload type on the Session Controller. You can configure a static-payload-type Resource to allow the Session Controller to support a codec with a static payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a static-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::custom_codec::static_payload_type_codec_type_t codec_type

Sets the codec type.

attribute perimeta::custom_codec::static_payload_type_media_type_t? media_type=null

Sets the media type for this custom codec.

attribute perimeta::custom_codec::static_payload_type_required_bandwidth_t? required_bandwidth=null

Specifies the default bandwidth requirement for this custom codec in bits per second.

attribute perimeta::custom_codec::static_payload_type_channels_t? channels=null

Sets the default number of channels.

attribute perimeta::custom_codec::static_payload_type_fidelity_t? fidelity=null

Sets the fidelity for the custom codec. This can be either standard definition (SD) or high definition (HD).

attribute perimeta::custom_codec::static_payload_type_max_frames_per_packet_t? max_frames_per_packet=null

Sets the default value for the maximum number of frames per packet.

attribute perimeta::custom_codec::static_payload_type_packetization_time_t? packetization_time=null

Sets the packetization time for this custom codec in milliseconds.

attribute perimeta::custom_codec::static_payload_type_clock_rate_t? clock_rate=null

Sets the default clock rate for this custom codec in hertz.

attribute perimeta::custom_codec::static_payload_type_sample_size_per_channel_t? sample_size_per_channel=null

Sets the sample size per channel for this custom codec in bits.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::custom_codec::static_payload_type_config

• perimeta::custom_codec::static_payload_type_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::custom_codec::static_payload_type_config, perimeta::custom_codec::static_payload_type_cross_device_relations constraint true

entity perimeta::custom_codec::StaticPayloadTypeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /custom-codec/static-payload-type Perimeta API resource. Abstract base entity. For concrete usage, see children StaticPayloadType and StaticPayloadTypeUnmanaged.

This Resource represents a custom codec with a static payload type on the Session Controller. You can configure a static-payload-type Resource to allow the Session Controller to support a codec with a static payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a static-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

attribute perimeta::custom_codec::static_payload_type_codec_name_t codec_name

Specifies the name of the codec. This must match the codec’s standard representation in SDP. Note that if you want to configure the SILK codec, you must use SILK/8000 for the narrowband codec or SILK/16000 for the wideband codec.

attribute perimeta::custom_codec::static_payload_type_payload_id_t payload_id

Specifies the payload type ID number that this custom codec will use.

The following implementations are defined for this entity:

• perimeta::custom_codec::static_payload_type_uri

The following implements statements select implementations for this entity:

• perimeta::custom_codec::static_payload_type_uri constraint true

entity perimeta::custom_codec::StaticPayloadTypeUnmanaged

Parents: perimeta::custom_codec::StaticPayloadTypeIdentity

Unmanaged reference to a /custom-codec/static-payload-type Perimeta API resource.

This Resource represents a custom codec with a static payload type on the Session Controller. You can configure a static-payload-type Resource to allow the Session Controller to support a codec with a static payload type that is not included in the default library of codecs. For each custom codec that you want to support, you must configure a static-payload-type Resource on the controlling SSC and on any MSCs that will handle calls using this codec.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::delegate_subscriber::DelegateSubscriber

Parents: perimeta::delegate_subscriber::DelegateSubscriberIdentity, std::PurgeableResource

Inmanta resource to manage a /delegate-subscriber Perimeta API resource.

Resource for a delegated subscriber. Allows you to configure the details of a subscriber that cannot register for itself, so that the Session Controller can register on its behalf. For more information, see Delegated registration in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DelegatedRegistration.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? activate=null

Activates the delegated registration.

attribute perimeta::delegate_subscriber::delegate_subscriber_registrar_hostname_t registrar_hostname

Sets the hostname of the registrar for the delegated registration.

attribute perimeta::delegate_subscriber::delegate_subscriber_duration_t? duration=null

Sets the duration of the registration.

attribute perimeta::delegate_subscriber::delegate_subscriber_refresh_buffer_t? refresh_buffer=null

Sets the amount of time before the registration expiry time at which the Session Controller should refresh the registration.

attribute perimeta::delegate_subscriber::delegate_subscriber_retry_count_t? retry_count=null

Sets the maximum number of times the Session Controller should retry the registration if it fails.

attribute perimeta::delegate_subscriber::delegate_subscriber_retry_interval_t? retry_interval=null

Sets the interval between registration retries.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel registrar_adjacency: Sets the adjacency over which the Session Controller will send the registration request.

relation perimeta::adjacency::SipIdentity registrar_adjacency [1]

Sets the adjacency over which the Session Controller will send the registration request. Peer relation:

The following implementations are defined for this entity:

• perimeta::delegate_subscriber::delegate_subscriber_config

• perimeta::delegate_subscriber::delegate_subscriber_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::delegate_subscriber::delegate_subscriber_config, perimeta::delegate_subscriber::delegate_subscriber_cross_device_relations constraint true

entity perimeta::delegate_subscriber::DelegateSubscriberIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /delegate-subscriber Perimeta API resource. Abstract base entity. For concrete usage, see children DelegateSubscriber and DelegateSubscriberUnmanaged.

Resource for a delegated subscriber. Allows you to configure the details of a subscriber that cannot register for itself, so that the Session Controller can register on its behalf. For more information, see Delegated registration in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DelegatedRegistration.html).

attribute perimeta::delegate_subscriber::delegate_subscriber_delegate_subscriber_t delegate_subscriber

The address of record for the subscriber. Must be a SIP URI, including the sip: prefix.

relation perimeta::delegate_subscriber::SipContactIdentity sip_contact [0:*]

other end: perimeta::delegate_subscriber::SipContactIdentity.delegate_subscriber [1]

The following implementations are defined for this entity:

• perimeta::delegate_subscriber::delegate_subscriber_uri

The following implements statements select implementations for this entity:

• perimeta::delegate_subscriber::delegate_subscriber_uri constraint true

entity perimeta::delegate_subscriber::DelegateSubscriberUnmanaged

Parents: perimeta::delegate_subscriber::DelegateSubscriberIdentity

Unmanaged reference to a /delegate-subscriber Perimeta API resource.

Resource for a delegated subscriber. Allows you to configure the details of a subscriber that cannot register for itself, so that the Session Controller can register on its behalf. For more information, see Delegated registration in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/DelegatedRegistration.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::delegate_subscriber::SipContact

Parents: perimeta::delegate_subscriber::SipContactIdentity, std::PurgeableResource

Inmanta resource to manage a /delegate-subscriber/sip-contact Perimeta API resource.

Resource for a set of contact details for the delegated subscriber. One subscriber can have multiple sets of contact details.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel subscriber_adjacency: Sets the adjacency over which the Session Controller will contact the subscriber at this URI.

relation perimeta::adjacency::SipIdentity subscriber_adjacency [1]

Sets the adjacency over which the Session Controller will contact the subscriber at this URI. Peer relation:

The following implementations are defined for this entity:

• perimeta::delegate_subscriber::sip_contact_config

• perimeta::delegate_subscriber::sip_contact_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::delegate_subscriber::sip_contact_config, perimeta::delegate_subscriber::sip_contact_cross_device_relations constraint true

entity perimeta::delegate_subscriber::SipContactIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /delegate-subscriber/sip-contact Perimeta API resource. Abstract base entity. For concrete usage, see children SipContact and SipContactUnmanaged.

Resource for a set of contact details for the delegated subscriber. One subscriber can have multiple sets of contact details.

attribute perimeta::delegate_subscriber::sip_contact_sip_contact_t sip_contact

The contact URI. Can be a SIP or TEL URI. Must include the sip: or tel: prefix.

relation perimeta::delegate_subscriber::DelegateSubscriberIdentity delegate_subscriber [1]

other end: perimeta::delegate_subscriber::DelegateSubscriberIdentity.sip_contact [0:*]

The following implementations are defined for this entity:

• perimeta::delegate_subscriber::sip_contact_uri

The following implements statements select implementations for this entity:

• perimeta::delegate_subscriber::sip_contact_uri constraint true

entity perimeta::delegate_subscriber::SipContactUnmanaged

Parents: perimeta::delegate_subscriber::SipContactIdentity

Unmanaged reference to a /delegate-subscriber/sip-contact Perimeta API resource.

Resource for a set of contact details for the delegated subscriber. One subscriber can have multiple sets of contact details.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::Diagnostics

Parents: perimeta::diagnostics::DiagnosticsIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics Perimeta API resource.

The diagnostics Resource allows you to manage the statistics collection interval for your Session Controller, which determines how long the Session Controller will wait between collections of global summary, per-adjacency and per-account statistics.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::diagnostics_statistics_collection_interval_t? statistics_collection_interval=null

Specifies the interval between collections of global, per-adjacency and per-account statistics. You can set this interval to any multiple of 15 seconds or minutes. You must specify the value using this Property and the time unit using the statistics-collection-interval-units Property. If you configure the statistics collection interval to a number of minutes that is not a factor of 60 or a number of seconds that is not a factor of 3,600, the final interval within the hour will be truncated. By default, the statistics collection interval is set to 5 minutes. For more information on setting the statistics collection interval, see Setting the statistics collection interval in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/SettingTheStatisticsCollectionInterval.html).

attribute perimeta::diagnostics::diagnostics_statistics_collection_interval_units_t? statistics_collection_interval_units=null

Specifies the time unit used for the statistics collection interval.

attribute perimeta::diagnostics::diagnostics_statistics_file_flip_interval_t? statistics_file_flip_interval=null

Specifies the CSV statistics file flip interval, which determines how long the Session Controller will wait before closing the current CSV statistics file and opening a new one. You can set this interval to any number of hours from 1 to 24. By default the statistics CSV flip interval is set to 24 hours. If you configure the CSV statistics file flip interval to a number of hours that is not a factor of 24, the final file of each calendar day will be truncated. A file will also be truncated if the Session Controller closed another file during the interval due to a restart, software protection switch or the file reaching a 100MB limit. For detailed information on the Session Controller’s behavior when generating CSV statistics files, see Statistics in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/Statistics.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel statistics_file_upload_server: Specifies whether the Session Controller will automatically upload closed CSV statistics files and, if so, the upload server to which it must upload the files. To enable automatic CSV statistics file uploads, you must use this Property to specify the Upload Server Resource that corresponds to the upload server to which the Session Controller must upload files. You can disable automatic CSV statistics file uploads by setting this Property with an empty value. For more information, see Enabling automatic CSV statistics file uploads in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/EnablingAutomaticCSVStatisticsFileUploads.html) and Disabling automatic CSV statistics file uploads in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/DisablingAutomaticCSVStatisticsFileUploads.html).

relation perimeta::diagnostics::UploadServerIdentity statistics_file_upload_server [0:1]

Specifies whether the Session Controller will automatically upload closed CSV statistics files and, if so, the upload

server to which it must upload the files.

To enable automatic CSV statistics file uploads, you must use this Property to specify the Upload Server Resource that corresponds to the upload server to which the Session Controller must upload files.

You can disable automatic CSV statistics file uploads by setting this Property with an empty value.

For more information, see Enabling automatic CSV statistics file uploads in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/EnablingAutomaticCSVStatisticsFileUploads.html) and Disabling automatic CSV statistics file uploads in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/DisablingAutomaticCSVStatisticsFileUploads.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::diagnostics::diagnostics_config

• perimeta::diagnostics::diagnostics_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::diagnostics_config, perimeta::diagnostics::diagnostics_cross_device_relations constraint true

entity perimeta::diagnostics::DiagnosticsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics Perimeta API resource. Abstract base entity. For concrete usage, see children Diagnostics and DiagnosticsUnmanaged.

The diagnostics Resource allows you to manage the statistics collection interval for your Session Controller, which determines how long the Session Controller will wait between collections of global summary, per-adjacency and per-account statistics.

The following implementations are defined for this entity:

• perimeta::diagnostics::diagnostics_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::diagnostics_uri constraint true

entity perimeta::diagnostics::DiagnosticsUnmanaged

Parents: perimeta::diagnostics::DiagnosticsIdentity

Unmanaged reference to a /diagnostics Perimeta API resource.

The diagnostics Resource allows you to manage the statistics collection interval for your Session Controller, which determines how long the Session Controller will wait between collections of global summary, per-adjacency and per-account statistics.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::MarkerAdjacency

Parents: perimeta::diagnostics::MarkerAdjacencyIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/marker/adjacency Perimeta API resource.

Configuration Resource for a diagnostics marker for an adjacency.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::marker_adjacency_sas_logging_level_t? sas_logging_level=null

Sets the amount of detail to send to the Service Assurance Server for calls matching this adjacency marker. The detailed level configures the Session Controller to send some detailed events that are only useful for troubleshooting purposes to the Service Assurance Server, for example events for each SIP Message Manipulation Framework rule applied to a call, in addition to per-call SIP Message Manipulation Framework events. For more information, see Troubleshooting: SIP Message Manipulation Framework and Lua message body editing in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/References/TroubleshootingSIPMessageManipulationFramework.html). You should only enable per-rule events for a small number of calls for testing or troubleshooting. You must not enable per-rule events for a significant number of calls because of the extra load on your Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel adjacency: Sets the adjacency on the Session Controller that this diagnostics marker applies to.

relation perimeta::adjacency::SipIdentity adjacency [1]

Sets the adjacency on the Session Controller that this diagnostics marker applies to. Peer relation:

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_adjacency_config

• perimeta::diagnostics::marker_adjacency_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_adjacency_config, perimeta::diagnostics::marker_adjacency_cross_device_relations constraint true

entity perimeta::diagnostics::MarkerAdjacencyIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/marker/adjacency Perimeta API resource. Abstract base entity. For concrete usage, see children MarkerAdjacency and MarkerAdjacencyUnmanaged.

Configuration Resource for a diagnostics marker for an adjacency.

attribute perimeta::diagnostics::marker_adjacency_name_t name

Name of this marker

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_adjacency_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_adjacency_uri constraint true

entity perimeta::diagnostics::MarkerAdjacencyUnmanaged

Parents: perimeta::diagnostics::MarkerAdjacencyIdentity

Unmanaged reference to a /diagnostics/marker/adjacency Perimeta API resource.

Configuration Resource for a diagnostics marker for an adjacency.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::MarkerNumber

Parents: perimeta::diagnostics::MarkerNumberIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/marker/number Perimeta API resource.

Configuration Resource for a diagnostics marker for a telephone number.

Markers on telephone numbers are not applied during the early stages of call setup (for example, when inbound MMF rules are applied, during calling-side processing for the initial INVITE, and following a Microsoft Teams transfer that uses an INVITE with a REPLACES). If possible, use one of the other types of filter, for example a filter on a SIP URI.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::marker_number_number_t number

Sets the telephone number that this diagnostics marker applies to.

attribute perimeta::diagnostics::marker_number_sas_logging_level_t? sas_logging_level=null

Sets the amount of detail to send to the Service Assurance Server for calls matching this telephone number marker. The detailed level configures the Session Controller to send some detailed events that are only useful for troubleshooting purposes to the Service Assurance Server, for example events for each SIP Message Manipulation Framework rule applied to a call, in addition to per-call SIP Message Manipulation Framework events. For more information, see Troubleshooting: SIP Message Manipulation Framework and Lua message body editing in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/References/TroubleshootingSIPMessageManipulationFramework.html). You should only enable per-rule events for a small number of calls for testing or troubleshooting. You must not enable per-rule events for a significant number of calls because of the extra load on your Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_number_config

• perimeta::diagnostics::marker_number_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_number_config, perimeta::diagnostics::marker_number_cross_device_relations constraint true

entity perimeta::diagnostics::MarkerNumberIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/marker/number Perimeta API resource. Abstract base entity. For concrete usage, see children MarkerNumber and MarkerNumberUnmanaged.

Configuration Resource for a diagnostics marker for a telephone number.

Markers on telephone numbers are not applied during the early stages of call setup (for example, when inbound MMF rules are applied, during calling-side processing for the initial INVITE, and following a Microsoft Teams transfer that uses an INVITE with a REPLACES). If possible, use one of the other types of filter, for example a filter on a SIP URI.

attribute perimeta::diagnostics::marker_number_name_t name

Name of this marker

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_number_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_number_uri constraint true

entity perimeta::diagnostics::MarkerNumberUnmanaged

Parents: perimeta::diagnostics::MarkerNumberIdentity

Unmanaged reference to a /diagnostics/marker/number Perimeta API resource.

Configuration Resource for a diagnostics marker for a telephone number.

Markers on telephone numbers are not applied during the early stages of call setup (for example, when inbound MMF rules are applied, during calling-side processing for the initial INVITE, and following a Microsoft Teams transfer that uses an INVITE with a REPLACES). If possible, use one of the other types of filter, for example a filter on a SIP URI.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::MarkerRemoteIp

Parents: perimeta::diagnostics::MarkerRemoteIpIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/marker/remote-ip Perimeta API resource.

Configuration Resource for a diagnostics marker for a remote IP address.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::marker_remote_ip_service_network_t service_network

The service network ID for the service network that is used by this address

attribute std::ipv_any_address remote_ip

Sets the remote IP address that this diagnostics marker applies to.

attribute perimeta::diagnostics::marker_remote_ip_sas_logging_level_t? sas_logging_level=null

Sets the amount of detail to send to the Service Assurance Server for calls matching this remote IP address marker. The detailed level configures the Session Controller to send some detailed events that are only useful for troubleshooting purposes to the Service Assurance Server, for example events for each SIP Message Manipulation Framework rule applied to a call, in addition to per-call SIP Message Manipulation Framework events. For more information, see Troubleshooting: SIP Message Manipulation Framework and Lua message body editing in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/References/TroubleshootingSIPMessageManipulationFramework.html). You should only enable per-rule events for a small number of calls for testing or troubleshooting. You must not enable per-rule events for a significant number of calls because of the extra load on your Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_remote_ip_config

• perimeta::diagnostics::marker_remote_ip_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_remote_ip_config, perimeta::diagnostics::marker_remote_ip_cross_device_relations constraint true

entity perimeta::diagnostics::MarkerRemoteIpIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/marker/remote-ip Perimeta API resource. Abstract base entity. For concrete usage, see children MarkerRemoteIp and MarkerRemoteIpUnmanaged.

Configuration Resource for a diagnostics marker for a remote IP address.

attribute perimeta::diagnostics::marker_remote_ip_name_t name

Name of this marker

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_remote_ip_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_remote_ip_uri constraint true

entity perimeta::diagnostics::MarkerRemoteIpUnmanaged

Parents: perimeta::diagnostics::MarkerRemoteIpIdentity

Unmanaged reference to a /diagnostics/marker/remote-ip Perimeta API resource.

Configuration Resource for a diagnostics marker for a remote IP address.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::MarkerServiceNetwork

Parents: perimeta::diagnostics::MarkerServiceNetworkIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/marker/service-network Perimeta API resource.

Configuration Resource for a diagnostics marker for a service network.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::marker_service_network_service_network_t service_network

Sets the service network that this marker applies to.

attribute perimeta::diagnostics::marker_service_network_sas_logging_level_t? sas_logging_level=null

Sets the amount of detail to send to the Service Assurance Server for calls matching this service network marker. The detailed level configures the Session Controller to send some detailed events that are only useful for troubleshooting purposes to the Service Assurance Server, for example events for each SIP Message Manipulation Framework rule applied to a call, in addition to per-call SIP Message Manipulation Framework events. For more information, see Troubleshooting: SIP Message Manipulation Framework and Lua message body editing in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/References/TroubleshootingSIPMessageManipulationFramework.html). You should only enable per-rule events for a small number of calls for testing or troubleshooting. You must not enable per-rule events for a significant number of calls because of the extra load on your Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_service_network_config

• perimeta::diagnostics::marker_service_network_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_service_network_config, perimeta::diagnostics::marker_service_network_cross_device_relations constraint true

entity perimeta::diagnostics::MarkerServiceNetworkIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/marker/service-network Perimeta API resource. Abstract base entity. For concrete usage, see children MarkerServiceNetwork and MarkerServiceNetworkUnmanaged.

Configuration Resource for a diagnostics marker for a service network.

attribute perimeta::diagnostics::marker_service_network_name_t name

Name of this marker

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_service_network_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_service_network_uri constraint true

entity perimeta::diagnostics::MarkerServiceNetworkUnmanaged

Parents: perimeta::diagnostics::MarkerServiceNetworkIdentity

Unmanaged reference to a /diagnostics/marker/service-network Perimeta API resource.

Configuration Resource for a diagnostics marker for a service network.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::MarkerUri

Parents: perimeta::diagnostics::MarkerUriIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/marker/uri Perimeta API resource.

Configuration Resource for a diagnostics marker for a URI.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::marker_uri_uri_t uri

Sets the URI that this marker applies to.

attribute perimeta::diagnostics::marker_uri_sas_logging_level_t? sas_logging_level=null

Sets the amount of detail to send to the Service Assurance Server for calls matching this URI marker. The detailed level configures the Session Controller to send some detailed events that are only useful for troubleshooting purposes to the Service Assurance Server, for example events for each SIP Message Manipulation Framework rule applied to a call, in addition to per-call SIP Message Manipulation Framework events. For more information, see Troubleshooting: SIP Message Manipulation Framework and Lua message body editing in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/References/TroubleshootingSIPMessageManipulationFramework.html). You should only enable per-rule events for a small number of calls for testing or troubleshooting. You must not enable per-rule events for a significant number of calls because of the extra load on your Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_uri_config

• perimeta::diagnostics::marker_uri_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_uri_config, perimeta::diagnostics::marker_uri_cross_device_relations constraint true

entity perimeta::diagnostics::MarkerUriIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/marker/uri Perimeta API resource. Abstract base entity. For concrete usage, see children MarkerUri and MarkerUriUnmanaged.

Configuration Resource for a diagnostics marker for a URI.

attribute perimeta::diagnostics::marker_uri_name_t name

Name of this marker

The following implementations are defined for this entity:

• perimeta::diagnostics::marker_uri_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::marker_uri_uri constraint true

entity perimeta::diagnostics::MarkerUriUnmanaged

Parents: perimeta::diagnostics::MarkerUriIdentity

Unmanaged reference to a /diagnostics/marker/uri Perimeta API resource.

Configuration Resource for a diagnostics marker for a URI.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::ServiceAssurance

Parents: perimeta::diagnostics::ServiceAssuranceIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/service-assurance Perimeta API resource.

Configuration mode for the Session Controller’s connection to one or more Service Assurance Servers. A Service Assurance Server provides a powerful set of tools for monitoring your Session Controller and diagnosing service issues. For more information, see Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/ServiceAssuranceServer.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? event_compression=null

Specifies whether to compress events (data) when sending them to the Service Assurance Server to save disk space and bandwidth. We recommend that you do not compress events if your Service Assurance Server is running 10.2 (virtualized environments) or 10.3 (COTS hardware) or above unless you cannot provide enough bandwidth for the uncompressed events, because these versions of the Service Assurance Server offer better compression than the Session Controller, so allowing the Service Assurance Server to perform compression saves more disk space. For more information, see Connecting a Session Controller to a Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/ConnectingASessionControllerToASASServer.html).

attribute bool? per_instance_servers=null

Specifies whether the Perimeta instances in a high availability system will send call diagnostics information to different Service Assurance Servers. This is only necessary for high availability systems in an OpenStack environment where the instances are deployed in different OpenStack clouds.

attribute perimeta::diagnostics::service_assurance_sas_discovery_t? sas_discovery=null

Configures the connection between the Session Controller and a discovery service for Service Assurance Servers for call diagnostics. Specify the DNS SRV name of the discovery service. The Session Controller will query DNS servers in the management network to retrieve the details of the discovery service’s instance. It will then request details of the available Service Assurance Servers from these instances. For more information on using this command, see Connecting a Session Controller to a Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/ConnectingASessionControllerToASASServer.html).

attribute bool? sas_discovery_use_default=null

Configures the connection between the Session Controller and a discovery service for Service Assurance Servers for call diagnostics. Specify the DNS SRV name of the discovery service. The Session Controller will query DNS servers in the management network to retrieve the details of the discovery service’s instance. It will then request details of the available Service Assurance Servers from these instances. For more information on using this command, see Connecting a Session Controller to a Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/ConnectingASessionControllerToASASServer.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::service_assurance_config

• perimeta::diagnostics::service_assurance_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::service_assurance_config, perimeta::diagnostics::service_assurance_cross_device_relations constraint true

entity perimeta::diagnostics::ServiceAssuranceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/service-assurance Perimeta API resource. Abstract base entity. For concrete usage, see children ServiceAssurance and ServiceAssuranceUnmanaged.

Configuration mode for the Session Controller’s connection to one or more Service Assurance Servers. A Service Assurance Server provides a powerful set of tools for monitoring your Session Controller and diagnosing service issues. For more information, see Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/ServiceAssuranceServer.html).

The following implementations are defined for this entity:

• perimeta::diagnostics::service_assurance_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::service_assurance_uri constraint true

entity perimeta::diagnostics::ServiceAssuranceSas

Parents: perimeta::diagnostics::ServiceAssuranceSasIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/service-assurance/sas Perimeta API resource.

Configuration mode for the Session Controller’s connection to a Service Assurance Server.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::service_assurance_sas_source_instance_t? source_instance=null

Set the instance of Perimeta that will connect to this Service Assurance Server

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::service_assurance_sas_config

• perimeta::diagnostics::service_assurance_sas_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::service_assurance_sas_config, perimeta::diagnostics::service_assurance_sas_cross_device_relations constraint true

entity perimeta::diagnostics::ServiceAssuranceSasIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/service-assurance/sas Perimeta API resource. Abstract base entity. For concrete usage, see children ServiceAssuranceSas and ServiceAssuranceSasUnmanaged.

Configuration mode for the Session Controller’s connection to a Service Assurance Server.

attribute std::ipv_any_address sas_ip

Specifies the IP address of the Service Assurance Server.

The following implementations are defined for this entity:

• perimeta::diagnostics::service_assurance_sas_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::service_assurance_sas_uri constraint true

entity perimeta::diagnostics::ServiceAssuranceSasUnmanaged

Parents: perimeta::diagnostics::ServiceAssuranceSasIdentity

Unmanaged reference to a /diagnostics/service-assurance/sas Perimeta API resource.

Configuration mode for the Session Controller’s connection to a Service Assurance Server.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::ServiceAssuranceUnmanaged

Parents: perimeta::diagnostics::ServiceAssuranceIdentity

Unmanaged reference to a /diagnostics/service-assurance Perimeta API resource.

Configuration mode for the Session Controller’s connection to one or more Service Assurance Servers. A Service Assurance Server provides a powerful set of tools for monitoring your Session Controller and diagnosing service issues. For more information, see Service Assurance Server in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Concepts/ServiceAssuranceServer.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::UploadServer

Parents: perimeta::diagnostics::UploadServerIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/upload-server Perimeta API resource.

Configuration mode for the Session Controller’s connection to an upload server. This mode allows you to configure an upload server to which the Session Controller can upload files. The upload server must be given an address (IPv4, IPv6 or FQDN), a username to use when connecting and the name of an SSH key (installed on perimeta) to use for authentication.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::diagnostics::upload_server_remote_address_t remote_address

Specifies the fully qualified domain name or IP address (IPv4 or IPv6) of the upload server. This must consist only of alphanumeric characters or the characters -_.: . It cannot begin with a - or . .

attribute perimeta::diagnostics::upload_server_remote_port_t? remote_port=null

Specifies the remote port number to use when connecting to this upload server.

attribute perimeta::diagnostics::upload_server_user_account_t user_account

Specifies the account name to use when connecting to this upload server.

attribute perimeta::diagnostics::upload_server_ssh_key_t ssh_key

Specifies the SSH private key to use when connecting to this upload server. You can select from SSH private keys that have already been created or imported using the Perimeta command line interface (CLI). For information on creating or importing SSH private keys, see Installing an SSH private key on a Session Controller in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/InstallingAnSSHPrivateKey.html).

attribute perimeta::diagnostics::upload_server_target_directory_t? target_directory=null

Specifies the path of the directory on the upload server to which the Session Controller must upload files. This can be an absolute path or relative to the ftp directory. It can contain nested directories in the format dir1/dir2/dir3. It must only contain letters, numbers and the following characters: _ - / If this is not configured, the Session Controller will upload files to the home directory of the user configured on the upload server.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::upload_server_config

• perimeta::diagnostics::upload_server_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::upload_server_config, perimeta::diagnostics::upload_server_cross_device_relations constraint true

entity perimeta::diagnostics::UploadServerIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/upload-server Perimeta API resource. Abstract base entity. For concrete usage, see children UploadServer and UploadServerUnmanaged.

Configuration mode for the Session Controller’s connection to an upload server. This mode allows you to configure an upload server to which the Session Controller can upload files. The upload server must be given an address (IPv4, IPv6 or FQDN), a username to use when connecting and the name of an SSH key (installed on perimeta) to use for authentication.

attribute perimeta::diagnostics::upload_server_server_name_t server_name

The name of the upload server to configure. This must consist only of alphanumeric characters or the characters -_.:. It cannot begin with a - or . .

The following implementations are defined for this entity:

• perimeta::diagnostics::upload_server_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::upload_server_uri constraint true

entity perimeta::diagnostics::UploadServerUnmanaged

Parents: perimeta::diagnostics::UploadServerIdentity

Unmanaged reference to a /diagnostics/upload-server Perimeta API resource.

Configuration mode for the Session Controller’s connection to an upload server. This mode allows you to configure an upload server to which the Session Controller can upload files. The upload server must be given an address (IPv4, IPv6 or FQDN), a username to use when connecting and the name of an SSH key (installed on perimeta) to use for authentication.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::diagnostics::VesEventReporting

Parents: perimeta::diagnostics::VesEventReportingIdentity, std::PurgeableResource

Inmanta resource to manage a /diagnostics/ves-event-reporting Perimeta API resource.

Configuration mode for Perimeta’s ONAP Virtual function Event Specification (VES) reporting feature. ONAP (Open Network Automation Platform) is a software platform for network automation, used for creating, monitoring and managing Virtual Network Functions (VNFs). The ONAP platform provides a Data Collection, Analytics and Events (DCAE) component which collects and collates data from VNFs for monitoring purposes. You can configure the Session Controller to report the statistics and alarms it generates to the DCAE in events. This allows for centralized monitoring and scaling of your Perimeta Session Controllers along with other VNFs. Session Controllers report events to the DCAE via a remote server known as a VES Collector.

For detailed information on enabling and configuring VES reporting, see Enabling Virtual function Event Stream (VES) reporting in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/EnablingVESReporting.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? activate=null

Specifies whether VES reporting is enabled on the Session Controller.

attribute perimeta::diagnostics::ves_event_reporting_address_t address

Specifies the IP address (IPv4 or IPv6) or fully-qualified domain name of the Virtual function Event Specification Collector (VES Collector) to which the Session Controller must report events when performing VES reporting.

attribute perimeta::diagnostics::ves_event_reporting_port_t? port=null

Specifies whether the Session Controller will use the default port for reporting events over HTTPS or HTTP, or whether it will use a specific port. Note that it is not possible to use any port other than port 80 for reporting events over HTTP. You must not configure the Session Controller to report events over HTTP in a live deployment, as this will pose a significant security risk. You can use HTTP during testing.

attribute perimeta::diagnostics::ves_event_reporting_port_value_t? port_value=null

Specifies the port on the Virtual function Event Stream Collector (VES Collector) to which the Session Controller must connect when reporting events over HTTPS. You must not set this Property to a value of 80, as this port is only used for reporting events over HTTP.

attribute perimeta::diagnostics::ves_event_reporting_username_t username

Specifies the username that the Session Controller will use for HTTP Basic Authentication if the Virtual function Event Stream Collector (VES Collector) requires authentication.

attribute perimeta::diagnostics::ves_event_reporting_password_t? password=null

Specifies the password that the Session Controller will use for HTTP Basic Authentication if the Virtual function Event Stream Collector (VES Collector) requires authentication. The string must only use the characters A-Z, a-z, 0-9, - and _.

attribute perimeta::diagnostics::ves_event_reporting_url_prefix_t? url_prefix=null

Specifies an optional prefix that will be included in the URL to which the Session Controller reports events. Specify a string of up to 32 characters, comprising A-Z, a-z, 0-9, - and _.

attribute perimeta::diagnostics::ves_event_reporting_url_topic_t? url_topic=null

Specifies an optional suffix that will be included in the URL to which the Session Controller reports events. This suffix is used by the interface to the Virtual function Event Stream Collector (VES Collector) to specify the event type that must be sent to this URL. Perimeta does not support filtering the events that it sends based on type and setting a value for this command will not affect this behavior. Perimeta will always send events of all types to the same URL. Specify a string of up to 32 characters, comprising A-Z, a-z, 0-9, - and _.

attribute perimeta::diagnostics::ves_event_reporting_heartbeat_interval_t? heartbeat_interval=null

Specifies the VES Collector Heartbeat interval in seconds. This determines how regularly the Session Controller will send heartbeat messages to the Virtual function Event Stream Collector (VES Collector) to confirm that the connection is still active.

attribute perimeta::diagnostics::ves_event_reporting_vnf_sample_rate_t? vnf_sample_rate=null

Specifies the sample rate for events with a Service Events or Signaling event domain. This is the proportion of calls for which the Session Controller will report events with these event domains, in the form “1 in every X calls”. The Session Controller will randomly capture 1 in X calls. This allows you to prioritize between ensuring that enough events are reported to give a reliable representation of service quality and the impact of sending these events on network load. Alternatively, if you do not want the Session Controller to report events with these event domains, you can set this field to 0 to disable this reporting.

attribute perimeta::diagnostics::ves_event_reporting_vnf_measurement_interval_t? vnf_measurement_interval=null

Specifies the VES Measurements for VF Scaling interval in seconds. This determines how regularly the Session Controller will send a Measurements for VF scaling event containing useful statistics for VNF scaling, including aggregate CPU usage and SIP signaling rate.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::diagnostics::ves_event_reporting_config

• perimeta::diagnostics::ves_event_reporting_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::diagnostics::ves_event_reporting_config, perimeta::diagnostics::ves_event_reporting_cross_device_relations constraint true

entity perimeta::diagnostics::VesEventReportingIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /diagnostics/ves-event-reporting Perimeta API resource. Abstract base entity. For concrete usage, see children VesEventReporting and VesEventReportingUnmanaged.

Configuration mode for Perimeta’s ONAP Virtual function Event Specification (VES) reporting feature. ONAP (Open Network Automation Platform) is a software platform for network automation, used for creating, monitoring and managing Virtual Network Functions (VNFs). The ONAP platform provides a Data Collection, Analytics and Events (DCAE) component which collects and collates data from VNFs for monitoring purposes. You can configure the Session Controller to report the statistics and alarms it generates to the DCAE in events. This allows for centralized monitoring and scaling of your Perimeta Session Controllers along with other VNFs. Session Controllers report events to the DCAE via a remote server known as a VES Collector.

For detailed information on enabling and configuring VES reporting, see Enabling Virtual function Event Stream (VES) reporting in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/EnablingVESReporting.html).

The following implementations are defined for this entity:

• perimeta::diagnostics::ves_event_reporting_uri

The following implements statements select implementations for this entity:

• perimeta::diagnostics::ves_event_reporting_uri constraint true

entity perimeta::diagnostics::VesEventReportingUnmanaged

Parents: perimeta::diagnostics::VesEventReportingIdentity

Unmanaged reference to a /diagnostics/ves-event-reporting Perimeta API resource.

Configuration mode for Perimeta’s ONAP Virtual function Event Specification (VES) reporting feature. ONAP (Open Network Automation Platform) is a software platform for network automation, used for creating, monitoring and managing Virtual Network Functions (VNFs). The ONAP platform provides a Data Collection, Analytics and Events (DCAE) component which collects and collates data from VNFs for monitoring purposes. You can configure the Session Controller to report the statistics and alarms it generates to the DCAE in events. This allows for centralized monitoring and scaling of your Perimeta Session Controllers along with other VNFs. Session Controllers report events to the DCAE via a remote server known as a VES Collector.

For detailed information on enabling and configuring VES reporting, see Enabling Virtual function Event Stream (VES) reporting in Perimeta Operations and Maintenance Guide (https://manuals.metaswitch.com/Perimeta/latest/OperationsAndMaintenance/Source/Perimeta/Tasks/EnablingVESReporting.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::guard::ListGuard

Parents: perimeta::PerimetaApiObject, std::PurgeableResource

Guards a Perimeta list/collection so that it contains only the members that are managed by the model. Any member present on the device whose URI is not part of the managed_items relation is considered unmanaged and is pruned.

The Perimeta API has no “replace the whole list” operation: every member is created and updated independently. As a result, members that exist on the device but were never put in the model are normally left untouched. This resource closes that gap by enumerating the actual members of the collection and deleting the ones we did not create.

Comparison happens at the URI level, so members may use different keys: any URI under the collection that is not in managed_items is pruned.

There can be only one guard per collection (enforced by the index): the guard is the single authority over the collection, so managed_items must list every member that should survive on the device.

All managed_items must live under collection_uri at the same depth. The Perimeta API nests composite keys into one container level per key part, so for a resource with a composite key its members are several levels below the collection; the guard walks the collection’s children down to that depth. For example media-address::Ip is keyed by ip and service_network, so guarding /media-address/ip manages the <ip>/<service_network> members two levels down, and IpPortRange (keyed by min_port and max_port) is guarded at the …/port-range collection.

attribute string collection_uri

The URI of the list container to guard, relative to the API version root, e.g. “/address-group/<name>/ip-address”, “/media-address/ip” or “/media-address/ip/<ip>/<service_network>/port-range”.

attribute bool report_only=false

When true, drift is reported (the resource is marked non-compliant) but no member is deleted. :rel managed_items: The members the model owns and that must therefore survive on the device. They must all live on the guard’s device and be direct children of collection_uri. Every other member of the collection is pruned.

relation perimeta::PerimetaApiObject managed_items [0:*]

The following implementations are defined for this entity:

• perimeta::guard::list_guard

The following implements statements select implementations for this entity:

• perimeta::guard::list_guard constraint true

entity perimeta::inbound_tunnel::InboundTunnel

Parents: perimeta::inbound_tunnel::InboundTunnelIdentity, std::PurgeableResource

Inmanta resource to manage a /inbound-tunnel Perimeta API resource.

Do not configure inbound-only tunnels unless you are specifically directed to by your Metaswitch support representative.

Configures an inbound-only VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::inbound_tunnel::inbound_tunnel_encapsulation_t encapsulation

Set how traffic on this tunnel is encapsulated

attribute perimeta::inbound_tunnel::inbound_tunnel_vni_t vni

VXLAN Network Identifier (VNI)

attribute perimeta::inbound_tunnel::inbound_tunnel_local_address_type_t local_address_type

Local address for the tunnel to use

attribute perimeta::inbound_tunnel::inbound_tunnel_per_instance_address_t? per_instance_address=null

Per-instance address for the tunnel to use

attribute perimeta::inbound_tunnel::inbound_tunnel_service_address_t? service_address=null

Service address for the tunnel to use

attribute bool? activate=null

Activate tunnel

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::inbound_tunnel::inbound_tunnel_config

• perimeta::inbound_tunnel::inbound_tunnel_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::inbound_tunnel::inbound_tunnel_config, perimeta::inbound_tunnel::inbound_tunnel_cross_device_relations constraint true

entity perimeta::inbound_tunnel::InboundTunnelIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /inbound-tunnel Perimeta API resource. Abstract base entity. For concrete usage, see children InboundTunnel and InboundTunnelUnmanaged.

Do not configure inbound-only tunnels unless you are specifically directed to by your Metaswitch support representative.

Configures an inbound-only VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

attribute perimeta::inbound_tunnel::inbound_tunnel_tunnel_name_t tunnel_name

Tunnel name

relation perimeta::inbound_tunnel::PeerIdentity peer [0:*]

other end: perimeta::inbound_tunnel::PeerIdentity.inbound_tunnel [1]

The following implementations are defined for this entity:

• perimeta::inbound_tunnel::inbound_tunnel_uri

The following implements statements select implementations for this entity:

• perimeta::inbound_tunnel::inbound_tunnel_uri constraint true

entity perimeta::inbound_tunnel::InboundTunnelUnmanaged

Parents: perimeta::inbound_tunnel::InboundTunnelIdentity

Unmanaged reference to a /inbound-tunnel Perimeta API resource.

Do not configure inbound-only tunnels unless you are specifically directed to by your Metaswitch support representative.

Configures an inbound-only VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::inbound_tunnel::Peer

Parents: perimeta::inbound_tunnel::PeerIdentity, std::PurgeableResource

Inmanta resource to manage a /inbound-tunnel/peer Perimeta API resource.

Specify a peer

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::inbound_tunnel::peer_peer_port_t? peer_port=null

Set the remote port this peer listens on, which Perimeta will also listen for traffic from this peer on.

attribute bool? peer_port_use_default=null

Set the remote port this peer listens on, which Perimeta will also listen for traffic from this peer on.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::inbound_tunnel::peer_config

• perimeta::inbound_tunnel::peer_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::inbound_tunnel::peer_config, perimeta::inbound_tunnel::peer_cross_device_relations constraint true

entity perimeta::inbound_tunnel::PeerIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /inbound-tunnel/peer Perimeta API resource. Abstract base entity. For concrete usage, see children Peer and PeerUnmanaged.

Specify a peer

attribute std::ipv_any_address peer_address

IP address

relation perimeta::inbound_tunnel::InboundTunnelIdentity inbound_tunnel [1]

other end: perimeta::inbound_tunnel::InboundTunnelIdentity.peer [0:*]

The following implementations are defined for this entity:

• perimeta::inbound_tunnel::peer_uri

The following implements statements select implementations for this entity:

• perimeta::inbound_tunnel::peer_uri constraint true

entity perimeta::inbound_tunnel::PeerUnmanaged

Parents: perimeta::inbound_tunnel::PeerIdentity

Unmanaged reference to a /inbound-tunnel/peer Perimeta API resource.

Specify a peer

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::interop_defaults::InteropDefaults

Parents: perimeta::interop_defaults::InteropDefaultsIdentity, std::PurgeableResource

Inmanta resource to manage a /interop-defaults Perimeta API resource.

Configuration mode for global defaults relating to SIP interoperability settings. Configuration on an interoperability profile or adjacency overrides the global defaults.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::interop_defaults::interop_defaults_dialog_transparency_t? dialog_transparency=null

Configures the global default for SIP dialog transparency. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute bool? dialog_transparency_use_default=null

Configures the global default for SIP dialog transparency. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute perimeta::interop_defaults::interop_defaults_distribute_expiry_t? distribute_expiry=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute bool? distribute_expiry_use_default=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute perimeta::interop_defaults::interop_defaults_priority_statistics_groups_t? priority_statistics_groups=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this interoperability profile.

attribute bool? priority_statistics_groups_use_default=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this interoperability profile.

attribute perimeta::interop_defaults::interop_defaults_signing_standard_t? signing_standard=null

Sets the STIR/SHAKEN standard to use by default when signing SIP messages. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? signing_standard_use_default=null

Sets the STIR/SHAKEN standard to use by default when signing SIP messages. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::interop_defaults::interop_defaults_verification_standard_t? verification_standard=null

Sets the STIR/SHAKEN standard to use by default when verifying SIP messages.Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? verification_standard_use_default=null

Sets the STIR/SHAKEN standard to use by default when verifying SIP messages.Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_defaults::interop_defaults_header_settings_respect_id_priority_t? header_settings_respect_id_priority=null

Specifies whether to use dialed numbers and usernames in INVITEs received on any adjacency to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_id_priority_use_default=null

Specifies whether to use dialed numbers and usernames in INVITEs received on any adjacency to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::interop_defaults::interop_defaults_custom_data_t? custom_data=null

A piece of arbitrary data that can be referenced in Message Manipulation profiles. Set a key and a value for the data, and it can be used in edit profiles as a variable: ${adj.custom_data.key}. The only characters allowed in a variable name are alphanumeric, ‘_’, and ‘.’.

attribute perimeta::interop_defaults::interop_defaults_custom_data_key_t? custom_data_key=null

Name of the custom data

attribute perimeta::interop_defaults::interop_defaults_custom_data_value_t? custom_data_value=null

Value of the custom data

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::interop_defaults::interop_defaults_config

• perimeta::interop_defaults::interop_defaults_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::interop_defaults::interop_defaults_config, perimeta::interop_defaults::interop_defaults_cross_device_relations constraint true

entity perimeta::interop_defaults::InteropDefaultsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /interop-defaults Perimeta API resource. Abstract base entity. For concrete usage, see children InteropDefaults and InteropDefaultsUnmanaged.

Configuration mode for global defaults relating to SIP interoperability settings. Configuration on an interoperability profile or adjacency overrides the global defaults.

The following implementations are defined for this entity:

• perimeta::interop_defaults::interop_defaults_uri

The following implements statements select implementations for this entity:

• perimeta::interop_defaults::interop_defaults_uri constraint true

entity perimeta::interop_defaults::InteropDefaultsUnmanaged

Parents: perimeta::interop_defaults::InteropDefaultsIdentity

Unmanaged reference to a /interop-defaults Perimeta API resource.

Configuration mode for global defaults relating to SIP interoperability settings. Configuration on an interoperability profile or adjacency overrides the global defaults.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::interop_profile::InteropProfile

Parents: perimeta::interop_profile::InteropProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /interop-profile Perimeta API resource.

Configuration mode for an adjacency interoperability profile. An adjacency interoperability profile allows you to define a set of SIP signaling settings that can be applied to multiple adjacencies. This can be useful if you have configured multiple adjacencies to SIP devices with the same SIP signaling requirements, such as multiple adjacencies to one softswitch, or to identical models of SIP phone. Updating the settings on an adjacency interoperability profile will update the SIP signaling settings for all adjacencies to which the profile is applied.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::interop_profile::interop_profile_dynamic_ims_aka_t? dynamic_ims_aka=null

Enabling this feature allows P-CSCF secure access adjacencies inheriting from this interoperabilty profile to accept SIP traffic from non-IMS-AKA endpoints. For more information, see Configuring dynamic IMS AKA detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringDynamicIMSAKA.html).

attribute bool? dynamic_ims_aka_use_default=null

Enabling this feature allows P-CSCF secure access adjacencies inheriting from this interoperabilty profile to accept SIP traffic from non-IMS-AKA endpoints. For more information, see Configuring dynamic IMS AKA detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringDynamicIMSAKA.html).

attribute perimeta::interop_profile::interop_profile_message_verification_t? message_verification=null

Specifies whether SIP request verification is enabled on this interoperability profile. When it is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the specified verification service. If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header. To enable this, you must use the header-settings verstat property at the global default, interoperability profile or adjacency scope. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? message_verification_use_default=null

Specifies whether SIP request verification is enabled on this interoperability profile. When it is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the specified verification service. If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header. To enable this, you must use the header-settings verstat property at the global default, interoperability profile or adjacency scope. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_profile::interop_profile_description_t? description=null

A short description for this adjacency interoperability profile. The description is used for clarity when viewing information about the adjacency interoperability profile.

attribute perimeta::interop_profile::interop_profile_preferred_transport_t? preferred_transport=null

Sets a preferred transport protocol to use for connections to endpoints in adjacencies using this interoperability profile.

attribute bool? preferred_transport_use_default=null

Sets a preferred transport protocol to use for connections to endpoints in adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_dynamic_peer_routing_t? dynamic_peer_routing=null

Specifies whether dynamic domain routing is enabled for adjacencies using this interoperability profile. With this enabled, dynamic-peer-routing entries in destination domain routing tables will route to an adjacency if the destination domain of the SIP message matches the configured dynamic routing match domain, or the signaling peer (or peer group hostname) if no match domain is configured. See Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html) for more information.

attribute bool? dynamic_peer_routing_use_default=null

Specifies whether dynamic domain routing is enabled for adjacencies using this interoperability profile. With this enabled, dynamic-peer-routing entries in destination domain routing tables will route to an adjacency if the destination domain of the SIP message matches the configured dynamic routing match domain, or the signaling peer (or peer group hostname) if no match domain is configured. See Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html) for more information.

attribute perimeta::interop_profile::interop_profile_dialog_transparency_t? dialog_transparency=null

Configures SIP dialog transparency on this interoperability profile. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute bool? dialog_transparency_use_default=null

Configures SIP dialog transparency on this interoperability profile. When SIP dialog transparency is enabled, the Session Controller uses the same dialog identifiers (the call-ID, From tag and To tag) on each dialog in a call instead of generating new dialog identifiers. For more information, see SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPDialogTransparency.html). For configuration instructions, see Configuring SIP dialog transparency in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPDialogTransparency.html).

attribute perimeta::interop_profile::interop_profile_message_signing_t? message_signing=null

Specifies whether SIP request signing is enabled on this interoperability profile. This overrides any global SIP request signing configuration. When SIP request signing is enabled, the Session Controller sends signing requests for all outbound INVITEs on this adjaceny that meet the following conditions to the specified signing service. - The INVITE does not already have an Identity header, and is therefore unsigned. - The call has an Attestation-Indicator header or a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number. - The call has an Origination-Id header or a P-Origination-Id header. This specifies the originator of the signing request. If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE. Perimeta Session CTo configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? message_signing_use_default=null

Specifies whether SIP request signing is enabled on this interoperability profile. This overrides any global SIP request signing configuration. When SIP request signing is enabled, the Session Controller sends signing requests for all outbound INVITEs on this adjaceny that meet the following conditions to the specified signing service. - The INVITE does not already have an Identity header, and is therefore unsigned. - The call has an Attestation-Indicator header or a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number. - The call has an Origination-Id header or a P-Origination-Id header. This specifies the originator of the signing request. If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE. Perimeta Session CTo configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::interop_profile::interop_profile_reinvite_without_sdp_t? reinvite_without_sdp=null

Configure how the Perimeta deals with reINVITEs with no SDP sent out of an adjacency inheriting from this interop profile.

attribute bool? reinvite_without_sdp_use_default=null

Configure how the Perimeta deals with reINVITEs with no SDP sent out of an adjacency inheriting from this interop profile.

attribute perimeta::interop_profile::interop_profile_distribute_expiry_t? distribute_expiry=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute bool? distribute_expiry_use_default=null

The percentage by which the Session Controller should reduce the expiry time on REGISTER responses from the registrar, in order to distribute registration traffic. For more information, see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute perimeta::interop_profile::interop_profile_priority_statistics_groups_t? priority_statistics_groups=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this interoperability profile.

attribute bool? priority_statistics_groups_use_default=null

Configures the Session Controller to collect priority call statistics from priority call statistics groups on this interoperability profile.

attribute perimeta::interop_profile::interop_profile_skip_peer_retry_on_503_t? skip_peer_retry_on_503=null

Specifies whether the Session Controller will skip retrying an alternative peer after receiving a 503 response, or attempt a retry if the limit set by dns-hunting-limit has not been reached. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute bool? skip_peer_retry_on_503_use_default=null

Specifies whether the Session Controller will skip retrying an alternative peer after receiving a 503 response, or attempt a retry if the limit set by dns-hunting-limit has not been reached. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute perimeta::interop_profile::interop_profile_retry_on_additional_sip_errors_t? retry_on_additional_sip_errors=null

Specifies up to ten additional SIP error codes which trigger a request to be retried to a different peer, unless the limit set by dns-hunting-limit has been reached. By default, only a 503 response triggers a retry. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. We recommend that you only set this on profiles used by adjacencies that use a peer group. If you set this on an adjacency that uses a static DNS signaling peer, the additional responses will count as 503s and may cause the peer to be marked as unavailable. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute bool? retry_on_additional_sip_errors_use_default=null

Specifies up to ten additional SIP error codes which trigger a request to be retried to a different peer, unless the limit set by dns-hunting-limit has been reached. By default, only a 503 response triggers a retry. If you change this behavior from the default, Perimeta will not comply with RFC 3261 or RFC 3623. We recommend that you only set this on profiles used by adjacencies that use a peer group. If you set this on an adjacency that uses a static DNS signaling peer, the additional responses will count as 503s and may cause the peer to be marked as unavailable. For more information, see Configuring peer group retry triggers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringPeerGroupRetryTriggers.html).

attribute perimeta::interop_profile::interop_profile_retry_on_additional_sip_errors_value_t? retry_on_additional_sip_errors_value=null

Quoted, space-separated string of SIP error codes (only 4xx, 5xx and 6xx).

attribute perimeta::interop_profile::interop_profile_call_handling_incomplete_information_t? call_handling_incomplete_information=null

Specifies the action to take if the Session Controller cannot try to verify the call because some of the information required to construct a verification request is missing.

attribute bool? call_handling_incomplete_information_use_default=null

Specifies the action to take if the Session Controller cannot try to verify the call because some of the information required to construct a verification request is missing.

attribute perimeta::interop_profile::interop_profile_call_handling_verification_failure_t? call_handling_verification_failure=null

Specifies the action to take if a verification request fails because the verification service does not respond with a value of “TN-Validation-Passed”. This can happen if the verification service cannot be contacted, responds with a 200 OK with a value other than “TN-Validation-Passed” or responds with an error. Note that if the connection to the verification service fails and you decide to reject calls when a verification request fails, your Session Controller will reject all calls that must either be verified successfully or rejected.

attribute bool? call_handling_verification_failure_use_default=null

Specifies the action to take if a verification request fails because the verification service does not respond with a value of “TN-Validation-Passed”. This can happen if the verification service cannot be contacted, responds with a 200 OK with a value other than “TN-Validation-Passed” or responds with an error. Note that if the connection to the verification service fails and you decide to reject calls when a verification request fails, your Session Controller will reject all calls that must either be verified successfully or rejected.

attribute perimeta::interop_profile::interop_profile_verification_standard_t? verification_standard=null

Sets the STIR/SHAKEN standard to use when verifying SIP messages on adjacencies using this interoperability profile. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? verification_standard_use_default=null

Sets the STIR/SHAKEN standard to use when verifying SIP messages on adjacencies using this interoperability profile. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_profile::interop_profile_signing_standard_t? signing_standard=null

Sets the STIR/SHAKEN standard to use when signing SIP messages on adjacencies using this interoperability profile. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? signing_standard_use_default=null

Sets the STIR/SHAKEN standard to use when signing SIP messages on adjacencies using this interoperability profile. Choose from: - ATIS-based (the overall default) - French MAN For information about the differences, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::interop_profile::interop_profile_emergency_calling_elin_support_t? emergency_calling_elin_support=null

Specifies whether Perimeta should search for and parse PIDF-LO message bodies in SIP INVITES for ELIN and subsequently update the P-Asserted-Identity header with this information on responses to those INVITEs received on adjacencies inheriting from this interoperability profile.

attribute bool? emergency_calling_elin_support_use_default=null

Specifies whether Perimeta should search for and parse PIDF-LO message bodies in SIP INVITES for ELIN and subsequently update the P-Asserted-Identity header with this information on responses to those INVITEs received on adjacencies inheriting from this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_rewrite_from_header_t? header_settings_rewrite_from_header=null

Specifies whether the Session Controller will rewrite the From header in outgoing SIP messages on adjacencies using this interoperability profile.

attribute bool? header_settings_rewrite_from_header_use_default=null

Specifies whether the Session Controller will rewrite the From header in outgoing SIP messages on adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_from_header_host_source_t? header_settings_from_header_host_source=null

Specifies the source the Session Controller must use to replace the host section of the From header.

attribute bool? header_settings_from_header_host_source_use_default=null

Specifies the source the Session Controller must use to replace the host section of the From header.

attribute perimeta::interop_profile::interop_profile_header_settings_include_port_in_from_header_t? header_settings_include_port_in_from_header=null

Specifies whether the Session Controller will include a port number in the rewritten URI.

attribute bool? header_settings_include_port_in_from_header_use_default=null

Specifies whether the Session Controller will include a port number in the rewritten URI.

attribute perimeta::interop_profile::interop_profile_header_settings_rewrite_to_header_t? header_settings_rewrite_to_header=null

Specifies whether the Session Controller must rewrite the To header in dialog-creating or out-of-dialog SIP requests (other than REGISTERs) on adjacencies using this interoperability profile.

attribute bool? header_settings_rewrite_to_header_use_default=null

Specifies whether the Session Controller must rewrite the To header in dialog-creating or out-of-dialog SIP requests (other than REGISTERs) on adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_inbound_via_handling_t? header_settings_inbound_via_handling=null

Specifies whether the Session Controller must pass through or strip Via headers on all inbound requests received by adjacencies using this interoperability profile.

attribute bool? header_settings_inbound_via_handling_use_default=null

Specifies whether the Session Controller must pass through or strip Via headers on all inbound requests received by adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_outbound_via_handling_t? header_settings_outbound_via_handling=null

Specifies whether the Session Controller must pass through or strip Via headers on all outbound requests received by adjacencies using this interoperability profile.

attribute bool? header_settings_outbound_via_handling_use_default=null

Specifies whether the Session Controller must pass through or strip Via headers on all outbound requests received by adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_suppress_expires_header_t? header_settings_suppress_expires_header=null

Specifies whether the Session Controller must remove the Expires header from SIP INVITE requests received by adjacencies using this interoperability profile.

attribute bool? header_settings_suppress_expires_header_use_default=null

Specifies whether the Session Controller must remove the Expires header from SIP INVITE requests received by adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_header_settings_respect_id_priority_t? header_settings_respect_id_priority=null

Specifies whether to use dialed numbers and usernames in INVITEs received on adjacencies inheriting from this interoperability profile to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_id_priority_use_default=null

Specifies whether to use dialed numbers and usernames in INVITEs received on adjacencies inheriting from this interoperability profile to apply priority categories to a call. By default, the Session Controller uses dialed numbers and usernames to apply priority categories. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::interop_profile::interop_profile_header_settings_respect_resource_priority_t? header_settings_respect_resource_priority=null

Specifies whether to use Resource Priority headers received on adjacencies using this interoperability profile to apply priority categories to a call. By default, the Session Controller only uses a Resource Priority header to apply priority categories if the header is received on a core adjacency. For a list of core adjacency types, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_resource_priority_use_default=null

Specifies whether to use Resource Priority headers received on adjacencies using this interoperability profile to apply priority categories to a call. By default, the Session Controller only uses a Resource Priority header to apply priority categories if the header is received on a core adjacency. For a list of core adjacency types, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::interop_profile::interop_profile_header_settings_respect_priority_t? header_settings_respect_priority=null

Specifies whether to use Priority headers received on adjacencies inheriting from this interop profile to apply priority categories to a call. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute bool? header_settings_respect_priority_use_default=null

Specifies whether to use Priority headers received on adjacencies inheriting from this interop profile to apply priority categories to a call. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::interop_profile::interop_profile_header_settings_contact_header_add_tls_t? header_settings_contact_header_add_tls=null

Specifies whether the Session Controller must add the transport=tls parameter to the Contact or Record-Route headers of SIP messages sent over adjacencies using this interoperability profile. This indicates to endpoints that they must use TLS, but might not be supported by some devices.

attribute bool? header_settings_contact_header_add_tls_use_default=null

Specifies whether the Session Controller must add the transport=tls parameter to the Contact or Record-Route headers of SIP messages sent over adjacencies using this interoperability profile. This indicates to endpoints that they must use TLS, but might not be supported by some devices.

attribute perimeta::interop_profile::interop_profile_header_settings_refer_to_uri_t? header_settings_refer_to_uri=null

Specifies the value the Session Controller must use when rewriting the URI in a Refer-To header for requests sent out over adjacencies using this interoperability profile. The Session Controller rewrites the URI in a Refer-To header as part of supporting Basic and Advanced call transfers. For detailed information on the circumstances in which the Session Controller will rewrite the URI in Refer-To headers, see SIP call transfer passthrough on the Session Controller in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPCallTransferPassthrough.html).

attribute bool? header_settings_refer_to_uri_use_default=null

Specifies the value the Session Controller must use when rewriting the URI in a Refer-To header for requests sent out over adjacencies using this interoperability profile. The Session Controller rewrites the URI in a Refer-To header as part of supporting Basic and Advanced call transfers. For detailed information on the circumstances in which the Session Controller will rewrite the URI in Refer-To headers, see SIP call transfer passthrough on the Session Controller in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPCallTransferPassthrough.html).

attribute perimeta::interop_profile::interop_profile_header_settings_p_asserted_id_t? header_settings_p_asserted_id=null

Specifies whether to add a P-Asserted-Identity header when forwarding messages received on adjacencies using this interoperability profile. If a P-Asserted-Identity header already exists, the new header replaces it. You must set this on the inbound side of the call.

attribute bool? header_settings_p_asserted_id_use_default=null

Specifies whether to add a P-Asserted-Identity header when forwarding messages received on adjacencies using this interoperability profile. If a P-Asserted-Identity header already exists, the new header replaces it. You must set this on the inbound side of the call.

attribute perimeta::interop_profile::interop_profile_p_asserted_id_header_t? p_asserted_id_header=null

Specifies the value of the P-Asserted-Identity header to add to the message when forwarding it.

attribute perimeta::interop_profile::interop_profile_header_settings_p_attestation_indicator_t? header_settings_p_attestation_indicator=null

Specifies whether to add a P-Attestation-Indicator header to the message. P-Attestation-Indicator headers are used by the Session Controller when creating a signing request for SIP request signing and when generating a custom verstat value after SIP request verification. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? header_settings_p_attestation_indicator_use_default=null

Specifies whether to add a P-Attestation-Indicator header to the message. P-Attestation-Indicator headers are used by the Session Controller when creating a signing request for SIP request signing and when generating a custom verstat value after SIP request verification. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_profile::interop_profile_p_attestation_ind_header_t? p_attestation_ind_header=null

Specifies the value of the P-Attestation-Indicator header to to add to the message. Specify one of the following. - A - you have a direct authenticated relationship with the calling customer and has established that the calling party is authorized to use the calling telephone number. - B - you have a direct authenticated relationship with the calling customer, but can not verify the calling party number information used for the call. - C - you have no relationship with the initiator of the call. - from-verification - the attestation level that was used during verification.

attribute perimeta::interop_profile::interop_profile_header_settings_p_origination_id_t? header_settings_p_origination_id=null

Specifies whether to add a P-Origination-Id header to the message P-Origination-Id headers are used by the Session Controller when creating a signing request for SIP request signing. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool? header_settings_p_origination_id_use_default=null

Specifies whether to add a P-Origination-Id header to the message P-Origination-Id headers are used by the Session Controller when creating a signing request for SIP request signing. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::interop_profile::interop_profile_p_origination_id_header_t? p_origination_id_header=null

Specifies the value of the P-Origination-Id header to to add to the message. The value should be a globally unique identifier for the originator of the signing request, for example the interoperability profile. from-verification inserts the identifier of the active instance.

attribute perimeta::interop_profile::interop_profile_header_settings_verstat_t? header_settings_verstat=null

Specifies whether to add a verstat parameter to the From or P-Asserted-Identity header in the message. Verstat parameters are used by a verification server as part of a SIP request signing process to determine the call’s level of signing and whether to verify the calling number information. They can also be used to mark unsigned calls. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? header_settings_verstat_use_default=null

Specifies whether to add a verstat parameter to the From or P-Asserted-Identity header in the message. Verstat parameters are used by a verification server as part of a SIP request signing process to determine the call’s level of signing and whether to verify the calling number information. They can also be used to mark unsigned calls. For more information, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html) and SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_profile::interop_profile_verstat_parameter_t? verstat_parameter=null

Specifies the value of the verstat parameter to add. Specify one of the following. - from-verification - the verstat value produced by the verification server (or, if you have configured the Session Controller to generate a new value using the value from the verification server, the call’s attestation level, and the verification schema, this new value). - TN-Validation-Passed - TN-Validation-Failed - No-TN-Validation

attribute perimeta::interop_profile::interop_profile_header_settings_reason_t? header_settings_reason=null

Adds a Reason header to all 18X and final responses when SIP request verification fails and specifies its value. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool? header_settings_reason_use_default=null

Adds a Reason header to all 18X and final responses when SIP request verification fails and specifies its value. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::interop_profile::interop_profile_ms_teams_version_header_t? ms_teams_version_header=null

Microsoft Teams requires an X-MS-SBC header specifying the SBC vendor, model and version on all outbound SIP messages in calls and SIP OPTIONs pings. This command adds the header to all relevant messages on adjacencies inheriting from this interoperability profile.

attribute bool? ms_teams_version_header_use_default=null

Microsoft Teams requires an X-MS-SBC header specifying the SBC vendor, model and version on all outbound SIP messages in calls and SIP OPTIONs pings. This command adds the header to all relevant messages on adjacencies inheriting from this interoperability profile.

attribute perimeta::interop_profile::interop_profile_3xx_embedded_headers_t? x_3xx_embedded_headers=null

Allows you to configure the Session Controller to pass through certain header types if they are embedded in a Contact header included in a 3xx response received on adjacencies using this adjacency interoperability profile. You can configure the Session Controller to pass through any of the following header types, including custom headers beginning with X-. - Attestation-Info - Date - Diversion - From - History-Info - Identity - Origination-Id - Privacy - P-Access-Network-Info - P-Asserted-Identity - P-Attestation-Indicator - P-Calling-Party-ID - P-Origination-Id - X- If you want to use a custom X-Header pattern, you should specify the patterns that you want to match in the comma-separated list. For custom X-Headers, as long as the header consists of valid SIP characters, Perimeta passes through the header if it begins with X- and is followed by a pattern that you configured. In the previous example, x-call-id is passed through but x-call is not. Alternatively, you can use the special value none to configure the Session Controller to drop all embedded header types, with the exception of Route headers which are always passed through. If you want to specify one or more header types to pass through, you must set this Property to “specify” and then use the 3xx-embedded-headers-value Property to set your chosen header types. Alternatively, you can set this Property to “none” to prevent the Session Controller from passing through any embedded headers, with the exception of Route headers which are always passed through. Any passed through headers either replace or add to the existing headers of that type depending on the setting of the 3xx-embedded-header-pass-mode field. The exceptions to this are in ADD mode the From and the Date headers, that always replace the existing header. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html) and Configuring SIP redirections in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPRedirections.html).

attribute bool? x_3xx_embedded_headers_use_default=null

Allows you to configure the Session Controller to pass through certain header types if they are embedded in a Contact header included in a 3xx response received on adjacencies using this adjacency interoperability profile. You can configure the Session Controller to pass through any of the following header types, including custom headers beginning with X-. - Attestation-Info - Date - Diversion - From - History-Info - Identity - Origination-Id - Privacy - P-Access-Network-Info - P-Asserted-Identity - P-Attestation-Indicator - P-Calling-Party-ID - P-Origination-Id - X- If you want to use a custom X-Header pattern, you should specify the patterns that you want to match in the comma-separated list. For custom X-Headers, as long as the header consists of valid SIP characters, Perimeta passes through the header if it begins with X- and is followed by a pattern that you configured. In the previous example, x-call-id is passed through but x-call is not. Alternatively, you can use the special value none to configure the Session Controller to drop all embedded header types, with the exception of Route headers which are always passed through. If you want to specify one or more header types to pass through, you must set this Property to “specify” and then use the 3xx-embedded-headers-value Property to set your chosen header types. Alternatively, you can set this Property to “none” to prevent the Session Controller from passing through any embedded headers, with the exception of Route headers which are always passed through. Any passed through headers either replace or add to the existing headers of that type depending on the setting of the 3xx-embedded-header-pass-mode field. The exceptions to this are in ADD mode the From and the Date headers, that always replace the existing header. For more information, see SIP redirection support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRedirectionSupport.html) and Configuring SIP redirections in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringSIPRedirections.html).

attribute perimeta::interop_profile::interop_profile_3xx_embedded_headers_value_t? x_3xx_embedded_headers_value=null

A comma-separated list of embedded header types to pass through on adjacencies using this adjacency interoperability profile. For example, p-asserted-identity,p-access-network-info.

attribute perimeta::interop_profile::interop_profile_registration_min_expiry_time_t? registration_min_expiry_time=null

Set the minimum registration expiry time (seconds) which the Session Controller uses for adjacencies using this interoperability profile. See Softswitch shielding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SoftswitchShielding.html) for more information.

attribute bool? registration_min_expiry_time_use_default=null

Set the minimum registration expiry time (seconds) which the Session Controller uses for adjacencies using this interoperability profile. See Softswitch shielding in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SoftswitchShielding.html) for more information.

attribute perimeta::interop_profile::interop_profile_registration_fast_register_t? registration_fast_register=null

Enables fast-registration on adjacencies using this interoperability profile. By default, this enables support for UDP, TCP and TLS endpoints. For information on fast-registration, see Fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FastRegistration.html).

attribute bool? registration_fast_register_use_default=null

Enables fast-registration on adjacencies using this interoperability profile. By default, this enables support for UDP, TCP and TLS endpoints. For information on fast-registration, see Fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/FastRegistration.html).

attribute perimeta::interop_profile::interop_profile_registration_fast_register_tcp_t? registration_fast_register_tcp=null

Configures support for fast-registration for endpoints using TCP or TLS. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_tcp_use_default=null

Configures support for fast-registration for endpoints using TCP or TLS. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::interop_profile::interop_profile_registration_fast_register_interval_t? registration_fast_register_interval=null

Sets the re-registration interval for endpoints behind a device performing NAT. The default is 30 seconds. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_interval_use_default=null

Sets the re-registration interval for endpoints behind a device performing NAT. The default is 30 seconds. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::interop_profile::interop_profile_registration_fast_register_non_nat_endpoints_t? registration_fast_register_non_nat_endpoints=null

Specifies whether fast-registration is enabled for endpoints that are not behind a device performing NAT. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::interop_profile::interop_profile_registration_fast_register_non_nat_interval_t? registration_fast_register_non_nat_interval=null

Sets the re-registration interval for endpoints that are not behind a device performing NAT. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::interop_profile::interop_profile_registration_fast_register_grace_timer_t? registration_fast_register_grace_timer=null

Sets the fast-registration grace period. If a fast-registered subscriber does not send another REGISTER after the fast register interval plus the grace period, the registration is removed.

attribute bool? registration_fast_register_grace_timer_use_default=null

Sets the fast-registration grace period. If a fast-registered subscriber does not send another REGISTER after the fast register interval plus the grace period, the registration is removed.

attribute perimeta::interop_profile::interop_profile_registration_fast_register_match_on_call_id_t? registration_fast_register_match_on_call_id=null

Enable or disable the match-on-call-id flag for this interop profile. If enabled, fast-registration will be bypassed if the Call-ID on the INVITE message changes. By default this flag is disabled, meaning that fast-registration will continue to be used even if the Call-ID changes. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute bool? registration_fast_register_match_on_call_id_use_default=null

Enable or disable the match-on-call-id flag for this interop profile. If enabled, fast-registration will be bypassed if the Call-ID on the INVITE message changes. By default this flag is disabled, meaning that fast-registration will continue to be used even if the Call-ID changes. For more information, see Configuring fast-registration in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringFastRegistration.html).

attribute perimeta::interop_profile::interop_profile_active_unregister_t? active_unregister=null

Enables active unregister. With this feature enabled, the Session Controller will send a de-register to the registrar if a subscriber stops fast-registering or is manually deleted from the subscriber database. For more information see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute bool? active_unregister_use_default=null

Enables active unregister. With this feature enabled, the Session Controller will send a de-register to the registrar if a subscriber stops fast-registering or is manually deleted from the subscriber database. For more information see SIP registration handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPRegistrationHandling.html).

attribute perimeta::interop_profile::interop_profile_hunting_t? hunting=null

Sets a list of error codes that will trigger hunting for adjacencies using this interoperability profile. If the Session Controller receives a code that triggers hunting after attempting to route a SIP request, it will retry routing unless the configured limit for retries has been reached. You can also use this command to disable hunting on this adjacency. If this setting is not configured, the Session Controller will use the globally configured list of hunting triggers for this interoperability profile. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html).

attribute bool? hunting_use_default=null

Sets a list of error codes that will trigger hunting for adjacencies using this interoperability profile. If the Session Controller receives a code that triggers hunting after attempting to route a SIP request, it will retry routing unless the configured limit for retries has been reached. You can also use this command to disable hunting on this adjacency. If this setting is not configured, the Session Controller will use the globally configured list of hunting triggers for this interoperability profile. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html).

attribute perimeta::interop_profile::interop_profile_hunting_triggers_t? hunting_triggers=null

A list of SIP error codes that will trigger standard hunting if received on an adjacency using this interoperability profile. Enter a space-separated list of the codes that you want to trigger standard hunting, enclosed in quotation marks, up to a maximum of 255 characters. If you do not enter a value into this field, the Session Controller will use the global list of error codes for standard hunting. Note that the global list of error codes of standard hunting can only be configured through the Perimeta command line interface (CLI) and is not accessible through MetaView Web.

attribute perimeta::interop_profile::interop_profile_options_ping_t? options_ping=null

Enables the use of SIP OPTIONS pings to monitor the availability of the signaling peer (on all configured addresses). For more information, see Peer availability detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerAvailabilityDetection.html).

attribute bool? options_ping_use_default=null

Enables the use of SIP OPTIONS pings to monitor the availability of the signaling peer (on all configured addresses). For more information, see Peer availability detection in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerAvailabilityDetection.html).

attribute perimeta::interop_profile::interop_profile_options_ping_mechanism_t? options_ping_mechanism=null

Specifies the mechanism the Session Controller will use when using SIP OPTIONS pings to monitor the availability of the static signaling peer of each adjacency using this interoperability profile (on all configured addresses). You can choose between the following mechanisms. - Continuous - The Session Controller will only use responses to SIP OPTIONS requests to identify whether peers are available. It will always send a SIP OPTIONS request at the end of the configured interval, regardless of the traffic that it receives from the peer. - Pause during traffic - The Session Controller will use responses to both SIP OPTIONS requests and other SIP traffic to determine whether peers available. As with continuous polling, the Session Controller will send a SIP OPTIONS request at the end of the configured interval. However, if the Session Controller receives a message of either of the following types from a peer before the interval ends, it will treat this message as an indication that the connection to the peer is still live and will restart the interval without sending a SIP OPTIONS request. - A SIP request - A SIP response to a request (other than a SIP OPTIONS request) with a response code that is included on the list of codes configured to be treated as successes using the non-options-ping-response command. We strongly recommend that you do not use the pause during traffic mechanism if the peer that the Session Controller must monitor is known to handle large amounts of traffic that is prone to short bursts of failures. If the pause during traffic mechanism is used with this type of peer, a short burst of failure responses to normal SIP traffic would cause the Session Controller to mark the connection to the peer as having failed, even though short bursts of failures are expected behavior and not an indication of a failed connection. This will result in the adjacency repeatedly moving between a healthy and a failed state.

attribute bool? options_ping_mechanism_use_default=null

Specifies the mechanism the Session Controller will use when using SIP OPTIONS pings to monitor the availability of the static signaling peer of each adjacency using this interoperability profile (on all configured addresses). You can choose between the following mechanisms. - Continuous - The Session Controller will only use responses to SIP OPTIONS requests to identify whether peers are available. It will always send a SIP OPTIONS request at the end of the configured interval, regardless of the traffic that it receives from the peer. - Pause during traffic - The Session Controller will use responses to both SIP OPTIONS requests and other SIP traffic to determine whether peers available. As with continuous polling, the Session Controller will send a SIP OPTIONS request at the end of the configured interval. However, if the Session Controller receives a message of either of the following types from a peer before the interval ends, it will treat this message as an indication that the connection to the peer is still live and will restart the interval without sending a SIP OPTIONS request. - A SIP request - A SIP response to a request (other than a SIP OPTIONS request) with a response code that is included on the list of codes configured to be treated as successes using the non-options-ping-response command. We strongly recommend that you do not use the pause during traffic mechanism if the peer that the Session Controller must monitor is known to handle large amounts of traffic that is prone to short bursts of failures. If the pause during traffic mechanism is used with this type of peer, a short burst of failure responses to normal SIP traffic would cause the Session Controller to mark the connection to the peer as having failed, even though short bursts of failures are expected behavior and not an indication of a failed connection. This will result in the adjacency repeatedly moving between a healthy and a failed state.

attribute perimeta::interop_profile::interop_profile_options_ping_response_t? options_ping_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the options-ping-response-failure-codes to specify your chosen list of response codes.

attribute bool? options_ping_response_use_default=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the options-ping-response-failure-codes to specify your chosen list of response codes.

attribute perimeta::interop_profile::interop_profile_options_ping_response_success_codes_t? options_ping_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::interop_profile::interop_profile_options_ping_response_failure_codes_t? options_ping_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::interop_profile::interop_profile_other_sip_response_t? other_sip_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a request other than a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the other-sip-response-success-codes Property to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the other-sip-response-failure-codes Property to specify your chosen list of response codes.

attribute bool? other_sip_response_use_default=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a request other than a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the other-sip-response-success-codes Property to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the other-sip-response-failure-codes Property to specify your chosen list of response codes.

attribute perimeta::interop_profile::interop_profile_other_sip_response_success_codes_t? other_sip_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a request other than a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::interop_profile::interop_profile_other_sip_response_failure_codes_t? other_sip_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::interop_profile::interop_profile_options_ping_failure_threshold_t? options_ping_failure_threshold=null

The number of consecutive failures necessary for the Session Controller to treat a connection as having failed. The Session Controller will register a failure in the following circumstances. - The Session Controller does not receive a response to a SIP OPTIONS request from the static signaling peer within the configured interval. - The Session Controller receives a response from the static signaling peer to a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the options-ping-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the options-ping-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will identify any response with a 3XX response code as a failure. - (Pause during traffic mechanism only) The Session Controller receives a response from the static signaling peer to any SIP request other than a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the other-sip-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the other-sip-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will not identify any response codes as failures.

attribute bool? options_ping_failure_threshold_use_default=null

The number of consecutive failures necessary for the Session Controller to treat a connection as having failed. The Session Controller will register a failure in the following circumstances. - The Session Controller does not receive a response to a SIP OPTIONS request from the static signaling peer within the configured interval. - The Session Controller receives a response from the static signaling peer to a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the options-ping-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the options-ping-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will identify any response with a 3XX response code as a failure. - (Pause during traffic mechanism only) The Session Controller receives a response from the static signaling peer to any SIP request other than a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the other-sip-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the other-sip-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will not identify any response codes as failures.

attribute perimeta::interop_profile::interop_profile_options_ping_interval_t? options_ping_interval=null

Sets the interval between sending each SIP OPTIONS ping (seconds).

attribute bool? options_ping_interval_use_default=null

Sets the interval between sending each SIP OPTIONS ping (seconds).

attribute perimeta::interop_profile::interop_profile_options_ping_lifetime_t? options_ping_lifetime=null

Sets the amount of time (seconds) that the Session Controller should wait for the response to a given ping.

attribute bool? options_ping_lifetime_use_default=null

Sets the amount of time (seconds) that the Session Controller should wait for the response to a given ping.

attribute perimeta::interop_profile::interop_profile_options_ping_max_forwards_t? options_ping_max_forwards=null

Configures the value of Max-Forwards header on generated OPTIONS pings

attribute bool? options_ping_max_forwards_use_default=null

Configures the value of Max-Forwards header on generated OPTIONS pings

attribute perimeta::interop_profile::interop_profile_respond_when_no_username_t? respond_when_no_username=null

Specifies how the Session Controller will handle OPTIONS requests with no username in the request-URI received on adjacencies using this interoperability profile. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute bool? respond_when_no_username_use_default=null

Specifies how the Session Controller will handle OPTIONS requests with no username in the request-URI received on adjacencies using this interoperability profile. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute perimeta::interop_profile::interop_profile_respond_when_no_username_max_forwards_limit_t? respond_when_no_username_max_forwards_limit=null

Specifies the maximum Max-Forwards header value on an OPTIONS request with no username in the request-URI to which the Session Controller will respond directly. If the value of the Max-Forwards header on an OPTIONS request is less than or equal to the value specified in this Property, the Session Controller will respond directly to it with a 200 OK. If the value of the Max-Forwards header on an OPTIONS request is more than the value specified in this Property, the Session Controller will route and forward the request.

attribute perimeta::interop_profile::interop_profile_respond_when_username_t? respond_when_username=null

Specifies how the Session Controller will handle OPTIONS requests with a username in the request-URI received on adjacencies using this interoperability profile. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute bool? respond_when_username_use_default=null

Specifies how the Session Controller will handle OPTIONS requests with a username in the request-URI received on adjacencies using this interoperability profile. For more information on SIP OPTIONS handling, see SIP OPTIONS handling in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SIPOPTIONSHandling.html).

attribute perimeta::interop_profile::interop_profile_respond_when_username_max_forwards_limit_t? respond_when_username_max_forwards_limit=null

Specifies the maximum Max-Forwards header value on an OPTIONS request with a username in the request-URI to which the Session Controller will respond directly. If the value of the Max-Forwards header on an OPTIONS request is less than or equal to the value specified in this field, the Session Controller will respond directly to it with a 200 OK. If the value of the Max-Forwards header on an OPTIONS request is more than the value specified in this field, the Session Controller will route and forward the request.

attribute perimeta::interop_profile::interop_profile_edit_profiles_inbound_t? edit_profiles_inbound=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to inbound messages on adjacencies using this interoperability profile. This must be a comma-separated list of SIP Message Manipulation profiles. For more information on applying profiles to an interoperability profile, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute bool? edit_profiles_inbound_use_default=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to inbound messages on adjacencies using this interoperability profile. This must be a comma-separated list of SIP Message Manipulation profiles. For more information on applying profiles to an interoperability profile, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute perimeta::interop_profile::interop_profile_edit_profiles_outbound_t? edit_profiles_outbound=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to outbound messages on adjacencies using this interoperability profile. This must be a comma-separated list of SIP Message Manipulation profiles. For more information on applying profiles to an interoperability profile, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute bool? edit_profiles_outbound_use_default=null

Specifies which SIP Message Manipulation and Lua profiles (other than SIP error profiles) the Session Controller should apply to outbound messages on adjacencies using this interoperability profile. This must be a comma-separated list of SIP Message Manipulation profiles. For more information on applying profiles to an interoperability profile, see Applying SIP Message Manipulation and Lua profiles to an adjacency in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ApplyingSIPMessageManipulationProfilesToAnAdjacency.html).

attribute perimeta::interop_profile::interop_profile_custom_data_t? custom_data=null

A piece of arbitrary data that can be referenced in Message Manipulation profiles. Set a key and a value for the data, and it can be used in edit profiles as a variable: ${adj.custom_data.key}. The only characters allowed in a variable name are alphanumeric, ‘_’, and ‘.’.

attribute perimeta::interop_profile::interop_profile_custom_data_key_t? custom_data_key=null

Name of the custom data

attribute perimeta::interop_profile::interop_profile_custom_data_value_t? custom_data_value=null

Value of the custom data

attribute perimeta::interop_profile::interop_profile_dtmf_force_passthrough_t? dtmf_force_passthrough=null

Specifies whether the Session Controller must passthrough all DTMF (in the signaling or media plane) sent or received on adjacencies using this interoperability profile, preventing any DTMF interworking.

attribute bool? dtmf_force_passthrough_use_default=null

Specifies whether the Session Controller must passthrough all DTMF (in the signaling or media plane) sent or received on adjacencies using this interoperability profile, preventing any DTMF interworking.

attribute perimeta::interop_profile::interop_profile_dtmf_preferred_method_t? dtmf_preferred_method=null

Specifies the preferred method for DTMF in SIP.

attribute bool? dtmf_preferred_method_use_default=null

Specifies the preferred method for DTMF in SIP.

attribute perimeta::interop_profile::interop_profile_dtmf_sip_notify_t? dtmf_sip_notify=null

Specifies whether the Session Controller will auto-detect or disable the use of SIP NOTIFY for DTMF on adjacencies using this interoperability profile.

attribute bool? dtmf_sip_notify_use_default=null

Specifies whether the Session Controller will auto-detect or disable the use of SIP NOTIFY for DTMF on adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_dtmf_sip_info_t? dtmf_sip_info=null

Specifies whether the Session Controller should disable, detect support for or assume support for DTMF using SIP INFO on adjacencies using this interoperability profile.

attribute bool? dtmf_sip_info_use_default=null

Specifies whether the Session Controller should disable, detect support for or assume support for DTMF using SIP INFO on adjacencies using this interoperability profile.

attribute perimeta::interop_profile::interop_profile_session_timer_mode_t? session_timer_mode=null

Sets the session timer mode for this interoperability profile. Session timers provide a keepalive mechanism for SIP sessions and set an upper limit on the amount of time for which a failed session can continue. For more information, see Session timers in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SessionTimers.html).

attribute perimeta::interop_profile::interop_profile_session_timer_min_session_expiry_t? session_timer_min_session_expiry=null

Minimum session expiry time in seconds or minutes

attribute perimeta::interop_profile::interop_profile_session_timer_min_session_expiry_units_t? session_timer_min_session_expiry_units=null

Units

attribute perimeta::interop_profile::interop_profile_session_timer_preferred_session_expiry_t? session_timer_preferred_session_expiry=null

Sets the preferred duration of a session timer. Proxies may decrease this value, provided it continues to be greater than the minimum duration.

attribute perimeta::interop_profile::interop_profile_session_timer_preferred_session_expiry_units_t? session_timer_preferred_session_expiry_units=null

Units

attribute perimeta::interop_profile::interop_profile_session_timer_preferred_refresh_originator_t? session_timer_preferred_refresh_originator=null

Specifies whether the Session Controller or the other device should initiate session refresh requests.

attribute perimeta::interop_profile::interop_profile_preconditions_t? preconditions=null

Configures whether the Session Controller should carry out preconditions interworking for calls where the outbound adjacency using this interoperability profile. Preconditions allow endpoints to reserve media resouces for calls. For more information, see Preconditions support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PreconditionsSupport.html) .

attribute bool? preconditions_use_default=null

Configures whether the Session Controller should carry out preconditions interworking for calls where the outbound adjacency using this interoperability profile. Preconditions allow endpoints to reserve media resouces for calls. For more information, see Preconditions support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PreconditionsSupport.html) .

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::interop_profile::interop_profile_config

• perimeta::interop_profile::interop_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::interop_profile::interop_profile_config, perimeta::interop_profile::interop_profile_cross_device_relations constraint true

entity perimeta::interop_profile::InteropProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /interop-profile Perimeta API resource. Abstract base entity. For concrete usage, see children InteropProfile and InteropProfileUnmanaged.

Configuration mode for an adjacency interoperability profile. An adjacency interoperability profile allows you to define a set of SIP signaling settings that can be applied to multiple adjacencies. This can be useful if you have configured multiple adjacencies to SIP devices with the same SIP signaling requirements, such as multiple adjacencies to one softswitch, or to identical models of SIP phone. Updating the settings on an adjacency interoperability profile will update the SIP signaling settings for all adjacencies to which the profile is applied.

attribute perimeta::interop_profile::interop_profile_sip_interop_profile_t sip_interop_profile

A name for this adjacency interoperability profile. This name is used whenever you refer to this adjacency interoperability profile in configuration.

The following implementations are defined for this entity:

• perimeta::interop_profile::interop_profile_uri

The following implements statements select implementations for this entity:

• perimeta::interop_profile::interop_profile_uri constraint true

entity perimeta::interop_profile::InteropProfileUnmanaged

Parents: perimeta::interop_profile::InteropProfileIdentity

Unmanaged reference to a /interop-profile Perimeta API resource.

Configuration mode for an adjacency interoperability profile. An adjacency interoperability profile allows you to define a set of SIP signaling settings that can be applied to multiple adjacencies. This can be useful if you have configured multiple adjacencies to SIP devices with the same SIP signaling requirements, such as multiple adjacencies to one softswitch, or to identical models of SIP phone. Updating the settings on an adjacency interoperability profile will update the SIP signaling settings for all adjacencies to which the profile is applied.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerAddress

Parents: perimeta::ip_access_control::BlocklistApplicationPerAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-application/per-address Perimeta API resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel blocklist_profile: Profile name

relation perimeta::ip_access_control::BlocklistProfileIdentity blocklist_profile [1]

Profile name Peer relation:

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_address_config

• perimeta::ip_access_control::blocklist_application_per_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_address_config, perimeta::ip_access_control::blocklist_application_per_address_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-application/per-address Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistApplicationPerAddress and BlocklistApplicationPerAddressUnmanaged.

attribute perimeta::ip_access_control::blocklist_application_per_address_service_network_id_t service_network_id

Service network ID

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_address_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_address_uri constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerAddressUnmanaged

Parents: perimeta::ip_access_control::BlocklistApplicationPerAddressIdentity

Unmanaged reference to a /ip-access-control/blocklist-application/per-address Perimeta API resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPort

Parents: perimeta::ip_access_control::BlocklistApplicationPerPortIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-application/per-port Perimeta API resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel blocklist_profile: Profile name

relation perimeta::ip_access_control::BlocklistProfileIdentity blocklist_profile [1]

Profile name Peer relation:

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_config

• perimeta::ip_access_control::blocklist_application_per_port_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_config, perimeta::ip_access_control::blocklist_application_per_port_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPortIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-application/per-port Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistApplicationPerPort and BlocklistApplicationPerPortUnmanaged.

attribute perimeta::ip_access_control::blocklist_application_per_port_service_network_id_t service_network_id

Service network ID

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_uri constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddress

Parents: perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-application/per-port-specific-address Perimeta API resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel blocklist_profile: Profile name

relation perimeta::ip_access_control::BlocklistProfileIdentity blocklist_profile [1]

Profile name Peer relation:

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_specific_address_config

• perimeta::ip_access_control::blocklist_application_per_port_specific_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_specific_address_config, perimeta::ip_access_control::blocklist_application_per_port_specific_address_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-application/per-port-specific-address Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistApplicationPerPortSpecificAddress and BlocklistApplicationPerPortSpecificAddressUnmanaged.

attribute perimeta::ip_access_control::blocklist_application_per_port_specific_address_service_network_id_t service_network_id

Service network ID

attribute std::ipv_any_address ip

The IP address for this blocklisting profile usage.

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_specific_address_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_per_port_specific_address_uri constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddressUnmanaged

Parents: perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddressIdentity

Unmanaged reference to a /ip-access-control/blocklist-application/per-port-specific-address Perimeta API resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistApplicationPerPortUnmanaged

Parents: perimeta::ip_access_control::BlocklistApplicationPerPortIdentity

Unmanaged reference to a /ip-access-control/blocklist-application/per-port Perimeta API resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistApplicationServiceNetwork

Parents: perimeta::ip_access_control::BlocklistApplicationServiceNetworkIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-application/service-network Perimeta API resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel blocklist_profile: Profile name

relation perimeta::ip_access_control::BlocklistProfileIdentity blocklist_profile [1]

Profile name Peer relation:

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_service_network_config

• perimeta::ip_access_control::blocklist_application_service_network_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_service_network_config, perimeta::ip_access_control::blocklist_application_service_network_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistApplicationServiceNetworkIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-application/service-network Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistApplicationServiceNetwork and BlocklistApplicationServiceNetworkUnmanaged.

attribute perimeta::ip_access_control::blocklist_application_service_network_service_network_id_t service_network_id

Service network ID

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_service_network_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_service_network_uri constraint true

entity perimeta::ip_access_control::BlocklistApplicationServiceNetworkUnmanaged

Parents: perimeta::ip_access_control::BlocklistApplicationServiceNetworkIdentity

Unmanaged reference to a /ip-access-control/blocklist-application/service-network Perimeta API resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistApplicationSpecificAddress

Parents: perimeta::ip_access_control::BlocklistApplicationSpecificAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-application/specific-address Perimeta API resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel blocklist_profile: Profile name

relation perimeta::ip_access_control::BlocklistProfileIdentity blocklist_profile [1]

Profile name Peer relation:

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_specific_address_config

• perimeta::ip_access_control::blocklist_application_specific_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_specific_address_config, perimeta::ip_access_control::blocklist_application_specific_address_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistApplicationSpecificAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-application/specific-address Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistApplicationSpecificAddress and BlocklistApplicationSpecificAddressUnmanaged.

attribute perimeta::ip_access_control::blocklist_application_specific_address_service_network_id_t service_network_id

Service network ID

attribute std::ipv_any_address ip

The IP address for this blocklisting profile usage.

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_application_specific_address_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_application_specific_address_uri constraint true

entity perimeta::ip_access_control::BlocklistApplicationSpecificAddressUnmanaged

Parents: perimeta::ip_access_control::BlocklistApplicationSpecificAddressIdentity

Unmanaged reference to a /ip-access-control/blocklist-application/specific-address Perimeta API resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::BlocklistProfile

Parents: perimeta::ip_access_control::BlocklistProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/blocklist-profile Perimeta API resource.

Configure blocklist profiles

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_profile_config

• perimeta::ip_access_control::blocklist_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_profile_config, perimeta::ip_access_control::blocklist_profile_cross_device_relations constraint true

entity perimeta::ip_access_control::BlocklistProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/blocklist-profile Perimeta API resource. Abstract base entity. For concrete usage, see children BlocklistProfile and BlocklistProfileUnmanaged.

Configure blocklist profiles

attribute perimeta::ip_access_control::blocklist_profile_name_t name

Profile name

The following implementations are defined for this entity:

• perimeta::ip_access_control::blocklist_profile_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::blocklist_profile_uri constraint true

entity perimeta::ip_access_control::BlocklistProfileUnmanaged

Parents: perimeta::ip_access_control::BlocklistProfileIdentity

Unmanaged reference to a /ip-access-control/blocklist-profile Perimeta API resource.

Configure blocklist profiles

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::TrustedSourcesAddress

Parents: perimeta::ip_access_control::TrustedSourcesAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/trusted-sources/address Perimeta API resource.

Specifies the IP address of an unknown, known or unrestricted source on a particular service network.

• For more information on unknown, known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::ip_access_control::trusted_sources_address_description_t? description=null

A description of this unknown, known or unrestricted source.

attribute perimeta::ip_access_control::trusted_sources_address_prioritization_t? prioritization=null

Specifies the priority of traffic from the permitted peer

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ip_access_control::trusted_sources_address_config

• perimeta::ip_access_control::trusted_sources_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::trusted_sources_address_config, perimeta::ip_access_control::trusted_sources_address_cross_device_relations constraint true

entity perimeta::ip_access_control::TrustedSourcesAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/trusted-sources/address Perimeta API resource. Abstract base entity. For concrete usage, see children TrustedSourcesAddress and TrustedSourcesAddressUnmanaged.

Specifies the IP address of an unknown, known or unrestricted source on a particular service network.

• For more information on unknown, known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

attribute perimeta::ip_access_control::trusted_sources_address_service_network_id_t service_network_id

The numerical ID of the service network over which the source will connect to the Session Controller.

attribute std::ipv_any_address ip

The IP address of the source.

The following implementations are defined for this entity:

• perimeta::ip_access_control::trusted_sources_address_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::trusted_sources_address_uri constraint true

entity perimeta::ip_access_control::TrustedSourcesAddressUnmanaged

Parents: perimeta::ip_access_control::TrustedSourcesAddressIdentity

Unmanaged reference to a /ip-access-control/trusted-sources/address Perimeta API resource.

Specifies the IP address of an unknown, known or unrestricted source on a particular service network.

• For more information on unknown, known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ip_access_control::TrustedSourcesRange

Parents: perimeta::ip_access_control::TrustedSourcesRangeIdentity, std::PurgeableResource

Inmanta resource to manage a /ip-access-control/trusted-sources/range Perimeta API resource.

Specifies a range of unknown, known or unrestricted sources on a particular service network.

• For more information on known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source range, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source range, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source range, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::ip_access_control::trusted_sources_range_description_t? description=null

A description of this unknown, known or unrestricted source range.

attribute perimeta::ip_access_control::trusted_sources_range_prioritization_t? prioritization=null

Specifies the priority of traffic from the permitted peer

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ip_access_control::trusted_sources_range_config

• perimeta::ip_access_control::trusted_sources_range_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::trusted_sources_range_config, perimeta::ip_access_control::trusted_sources_range_cross_device_relations constraint true

entity perimeta::ip_access_control::TrustedSourcesRangeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ip-access-control/trusted-sources/range Perimeta API resource. Abstract base entity. For concrete usage, see children TrustedSourcesRange and TrustedSourcesRangeUnmanaged.

Specifies a range of unknown, known or unrestricted sources on a particular service network.

• For more information on known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source range, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source range, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source range, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

attribute perimeta::ip_access_control::trusted_sources_range_service_network_id_t service_network_id

The numerical ID of the service network over which sources in the source range will connect to the Session Controller.

attribute std::ipv_any_address ip_start

The IP address of the first source in the source range.

attribute std::ipv_any_address ip_end

The IP address of the last source in the source range.

The following implementations are defined for this entity:

• perimeta::ip_access_control::trusted_sources_range_uri

The following implements statements select implementations for this entity:

• perimeta::ip_access_control::trusted_sources_range_uri constraint true

entity perimeta::ip_access_control::TrustedSourcesRangeUnmanaged

Parents: perimeta::ip_access_control::TrustedSourcesRangeIdentity

Unmanaged reference to a /ip-access-control/trusted-sources/range Perimeta API resource.

Specifies a range of unknown, known or unrestricted sources on a particular service network.

• For more information on known and unrestricted sources, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

• For more information on using this command to configure an unknown source range, see Configuring unknown sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnknownSources.html).

• For more information on using this command to configure a known source range, see Configuring known sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAKnownSource.html).

• For more information on using this command to configure an unrestricted source range, see Configuring unrestricted sources in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringUnrestrictedSources.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ipsec_peer::CryptoAlgorithmsProposal

Parents: perimeta::ipsec_peer::CryptoAlgorithmsProposalIdentity, std::PurgeableResource

Inmanta resource to manage a /ipsec-peer/crypto-algorithms-proposal Perimeta API resource.

Specifies a set of cryptographic algorithms for this IPsec peer.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? encryption_3des=null

Allow 3-DES encryption

attribute bool? encryption_aes128=null

Allow AES encryption with 128-bit keys in CBC mode

attribute bool? encryption_aes128ccm64=null

Allow AES encryption with 128-bit keys in CCM mode with 64-bit IV

attribute bool? encryption_aes128ccm96=null

Allow AES encryption with 128-bit keys in CCM mode with 96-bit IV

attribute bool? encryption_aes128ccm128=null

Allow AES encryption with 128-bit keys in CCM mode with 128-bit IV

attribute bool? encryption_aes128gcm64=null

Allow AES encryption with 128-bit keys in GCM mode with 64-bit IV

attribute bool? encryption_aes128gcm96=null

Allow AES encryption with 128-bit keys in GCM mode with 96-bit IV

attribute bool? encryption_aes128gcm128=null

Allow AES encryption with 128-bit keys in GCM mode with 128-bit IV

attribute bool? encryption_aes128ctr=null

Allow AES encryption with 128-bit keys in CTR mode

attribute bool? encryption_aes192=null

Allow AES encryption with 192-bit keys in CBC mode

attribute bool? encryption_aes192ccm64=null

Allow AES encryption with 192-bit keys in CCM mode with 64-bit IV

attribute bool? encryption_aes192ccm96=null

Allow AES encryption with 192-bit keys in CCM mode with 96-bit IV

attribute bool? encryption_aes192ccm128=null

Allow AES encryption with 192-bit keys in CCM mode with 128-bit IV

attribute bool? encryption_aes192gcm64=null

Allow AES encryption with 192-bit keys in GCM mode with 64-bit IV

attribute bool? encryption_aes192gcm96=null

Allow AES encryption with 192-bit keys in GCM mode with 96-bit IV

attribute bool? encryption_aes192gcm128=null

Allow AES encryption with 192-bit keys in GCM mode with 128-bit IV

attribute bool? encryption_aes192ctr=null

Allow AES encryption with 192-bit keys in CTR mode

attribute bool? encryption_aes256=null

Allow AES encryption with 256-bit keys in CBC mode

attribute bool? encryption_aes256ccm64=null

Allow AES encryption with 256-bit keys in CCM mode with 64-bit IV

attribute bool? encryption_aes256ccm96=null

Allow AES encryption with 256-bit keys in CCM mode with 96-bit IV

attribute bool? encryption_aes256ccm128=null

Allow AES encryption with 256-bit keys in CCM mode with 128-bit IV

attribute bool? encryption_aes256gcm64=null

Allow AES encryption with 256-bit keys in GCM mode with 64-bit IV

attribute bool? encryption_aes256gcm96=null

Allow AES encryption with 256-bit keys in GCM mode with 96-bit IV

attribute bool? encryption_aes256gcm128=null

Allow AES encryption with 256-bit keys in GCM mode with 128-bit IV

attribute bool? encryption_aes256ctr=null

Allow AES encryption with 256-bit keys in CTR mode

attribute bool? encryption_blowfish128=null

Allow Blowfish encryption with 128-bit keys in CBC mode

attribute bool? encryption_blowfish192=null

Allow Blowfish encryption with 192-bit keys in CBC mode

attribute bool? encryption_blowfish256=null

Allow Blowfish encryption with 192-bit keys in CBC mode

attribute bool? encryption_null=null

Allow unencrypted communication (not recommended, except for AH mode)

attribute bool? integrity_aesxcbc=null

Allow hashes using AES in CBC mode with IPsec extensions

attribute bool? integrity_md5=null

Allow MD5 hashes (not recommended)

attribute bool? integrity_sha1=null

Allow SHA-1 hashes (not recommended)

attribute bool? integrity_sha256=null

Allow SHA-256 hashes

attribute bool? integrity_sha384=null

Allow SHA-384 hashes

attribute bool? integrity_sha512=null

Allow SHA-512 hashes

attribute bool? dhgroup_modp768=null

Allow 768-bit prime moduli (DH group 1) (not recommended)

attribute bool? dhgroup_modp1024=null

Allow 1024-bit prime moduli (DH group 2) (not recommended)

attribute bool? dhgroup_modp1024s160=null

Allow 1024-bit prime moduli with 160-bit sub-groups (DH group 22)

attribute bool? dhgroup_modp1536=null

Allow 1536-bit prime moduli (DH group 5)

attribute bool? dhgroup_modp2048=null

Allow 2048-bit prime moduli (DH group 14)

attribute bool? dhgroup_modp2048s224=null

Allow 2048-bit prime moduli with 224-bit sub-groups (DH group 23)

attribute bool? dhgroup_modp2048s256=null

Allow 2048-bit prime moduli with 256-bit sub-groups (DH group 24)

attribute bool? dhgroup_modp3072=null

Allow 3072-bit prime moduli (DH group 15)

attribute bool? dhgroup_modp4096=null

Allow 4096-bit prime moduli (DH group 16)

attribute bool? dhgroup_modp6144=null

Allow 6144-bit prime moduli (DH group 17)

attribute bool? dhgroup_modp8192=null

Allow 8192-bit prime moduli (DH group 18)

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ipsec_peer::crypto_algorithms_proposal_config

• perimeta::ipsec_peer::crypto_algorithms_proposal_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::crypto_algorithms_proposal_config, perimeta::ipsec_peer::crypto_algorithms_proposal_cross_device_relations constraint true

entity perimeta::ipsec_peer::CryptoAlgorithmsProposalIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ipsec-peer/crypto-algorithms-proposal Perimeta API resource. Abstract base entity. For concrete usage, see children CryptoAlgorithmsProposal and CryptoAlgorithmsProposalUnmanaged.

Specifies a set of cryptographic algorithms for this IPsec peer.

attribute perimeta::ipsec_peer::crypto_algorithms_proposal_priority_t priority

Priority of the proposal (lower numbered proposals are preferred)

relation perimeta::ipsec_peer::IpsecPeerIdentity ipsec_peer [1]

other end: perimeta::ipsec_peer::IpsecPeerIdentity.crypto_algorithms_proposal [0:*]

The following implementations are defined for this entity:

• perimeta::ipsec_peer::crypto_algorithms_proposal_uri

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::crypto_algorithms_proposal_uri constraint true

entity perimeta::ipsec_peer::CryptoAlgorithmsProposalUnmanaged

Parents: perimeta::ipsec_peer::CryptoAlgorithmsProposalIdentity

Unmanaged reference to a /ipsec-peer/crypto-algorithms-proposal Perimeta API resource.

Specifies a set of cryptographic algorithms for this IPsec peer.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ipsec_peer::IpsecPeer

Parents: perimeta::ipsec_peer::IpsecPeerIdentity, std::PurgeableResource

Inmanta resource to manage a /ipsec-peer Perimeta API resource.

Configuration mode for a connection to an IPsec peer. For more information on IPsec peers, see IPsec support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.6/ConfigurationAndInterop/Source/Perimeta/Concepts/IPsec.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::ipsec_peer::ipsec_peer_description_t? description=null

Sets a useful description for the IPsec peer.

attribute perimeta::ipsec_peer::ipsec_peer_local_service_address_t local_service_address

Sets the local service address from which the Session Controller will connect to the IPsec peer.

attribute std::ipv_any_address remote_peer_outer_ip_address

Set IPv4 remote address

attribute perimeta::ipsec_peer::ipsec_peer_pre_shared_key_type_t? pre_shared_key_type=null

Sets the pre-shared key for authentication with this peer. NOTE: You may receive warnings on GET responses that indicate a pre-shared key for an IPsec peer is missing, even when it is present. If the “_state” property of the response is “ok”, the pre-shared key is present on the IPsec peer and you don’t need to take any action. If the “_state” property is “alarmed”, then the pre-shared key is missing and you need to add one.

attribute perimeta::ipsec_peer::ipsec_peer_pre_shared_key_value_t pre_shared_key_value

Pre-shared key encoded with chosen encryption type.

attribute perimeta::ipsec_peer::ipsec_peer_liveness_check_interval_t? liveness_check_interval=null

Specifies whether the Session Controller must use the Dead Peer Detection protocol to verify the liveliness of this IPsec peer and, if so, how regularly R_U_THERE notification messages (for IKEv1) or INFORMATIONAL messages (IKEv2) should be sent. Set to 0 to disable.

attribute perimeta::ipsec_peer::ipsec_peer_liveness_check_attempts_t? liveness_check_attempts=null

Specifies the number of R_U_THERE notification messages (for IKEv1) or INFORMATIONAL messages (IKEv2) that the Session Controller will send to this IPsec peer without response before marking the connection as dead.

attribute bool? activate=null

Specifies whether this peer is active

attribute perimeta::ipsec_peer::ipsec_peer_local_identity_t? local_identity=null

Specifies the local IKE identity that the Session Controller must send in the exchange with this IPsec peer. If you do not specify a local IKE identity, the Session Controller will use the local service address.

attribute perimeta::ipsec_peer::ipsec_peer_local_identity_value_t? local_identity_value=null

Identity (IP address or FQDN) to use when authenticating Perimeta to this peer

attribute perimeta::ipsec_peer::ipsec_peer_remote_identity_t? remote_identity=null

Specifies the remote IKE identity that the Session Controller will use when authenticating this IPsec peer. If you do not specify a remote IKE identity, the Session Controller will use the remote outer address.

attribute perimeta::ipsec_peer::ipsec_peer_remote_identity_value_t? remote_identity_value=null

Identity of the remote peer (IP address or FQDN), checked during authentication

attribute perimeta::ipsec_peer::ipsec_peer_key_exchange_type_t? key_exchange_type=null

Details of key exchange with this peer

attribute perimeta::ipsec_peer::ipsec_peer_key_exchange_remote_port_t? key_exchange_remote_port=null

Sets the remote port on the peer to which the Session Controller must connect for the initial key exchange. Note that this value may change to 4500 if the MOBIKE IKEv2 extension is in use or if NAT is detected.

attribute perimeta::ipsec_peer::ipsec_peer_key_exchange_remote_port_value_t? key_exchange_remote_port_value=null

Port number

attribute bool? use_ikev1_aggressive_mode=null

Specifies whether aggressive mode should be used when establishing a security association with this IPsec peer. Note that the use of aggressive mode risks revealing a weakly protected version of the pre-shared key for this connection and is not recommended. Aggressive mode is only supported when using IKEv1.

attribute perimeta::ipsec_peer::ipsec_peer_use_ikev1_fragmentation_mode_t? use_ikev1_fragmentation_mode=null

Specifies whether the Session Controller will support IKE packet fragmentation using the IKEv1 fragmentation extension. If this is enabled and the IPsec peer supports fragmentation, the Session Controller will send larger IKE messages in fragments. If this is set to force, the Session Controller will send larger IKE messages in fragments even if the extension is not supported by the IPsec peer.

attribute bool? disable_ikev2_mobike_extension=null

Specifies whether the MOBIKE IKEv2 extension is disabled for communications with this IPsec peer. The MOBIKE IKEv2 extension allows IPsec peers to move connections to another interface or address if necessary.

attribute bool? compress_data_before_encryption=null

Specifies whether the Session Controller may compress IPsec packets before transmitting them to this IPsec peer.

attribute perimeta::ipsec_peer::ipsec_peer_rekey_margin_t? rekey_margin=null

Specifies whether IPsec security associations for this IPsec peer should be rekeyed before they expire and, if so, the percentage of the key-lifetime limit that must be reached before the rekeying takes place.

attribute perimeta::ipsec_peer::ipsec_peer_rekey_margin_randomize_t? rekey_margin_randomize=null

Specifies whether the rekey margin should be increased by a random percentage and, if so, the maximum percentage by which it should be increased. Randomizing the rekey margin minimizes the chances of the Session Controller and the IPsec peer both attempting to rekey at the same time.

attribute bool? rekey_only=null

Specifies whether the Session Controller should only rekey the IKE security association on the expiration of an encryption key. If this option is not selected, the Session Controller will fully reauthenticate the IKE security association on the expiration of a encryption key.

attribute perimeta::ipsec_peer::ipsec_peer_refresh_after_t? refresh_after=null

Specifies how the key exchange connection is rekeyed.

attribute perimeta::ipsec_peer::ipsec_peer_refresh_after_units_t? refresh_after_units=null

Hours or minutes

attribute perimeta::ipsec_peer::ipsec_peer_refresh_after_value_t? refresh_after_value=null

Lifetime of key exchange connection in hours or minutes

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_t? key_lifetime_data_limit=null

Specifies whether the amount of data passed on an IPsec connection is used to control key expiry

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_units_t? key_lifetime_data_limit_units=null

Specifies the units in which data is measured for key expiry

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_data_limit_value_t? key_lifetime_data_limit_value=null

Specifies the amount of data for key expiry

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_t? key_lifetime_interval_limit=null

Specifies whether a time interval is used to control key expiry.

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_units_t? key_lifetime_interval_limit_units=null

Specifies the units in which time is measured for key expiry.

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_interval_limit_value_t? key_lifetime_interval_limit_value=null

Specifies the amount of time for key expiry.

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_packets_limit_t? key_lifetime_packets_limit=null

Specifies whether the number of packets passed on an IPsec connection is used to control key expiry.

attribute perimeta::ipsec_peer::ipsec_peer_key_lifetime_packets_limit_value_t? key_lifetime_packets_limit_value=null

Specifies the number of packets for key expiry.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ipsec_peer::ipsec_peer_config

• perimeta::ipsec_peer::ipsec_peer_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::ipsec_peer_config, perimeta::ipsec_peer::ipsec_peer_cross_device_relations constraint true

entity perimeta::ipsec_peer::IpsecPeerIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ipsec-peer Perimeta API resource. Abstract base entity. For concrete usage, see children IpsecPeer and IpsecPeerUnmanaged.

Configuration mode for a connection to an IPsec peer. For more information on IPsec peers, see IPsec support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.6/ConfigurationAndInterop/Source/Perimeta/Concepts/IPsec.html).

attribute perimeta::ipsec_peer::ipsec_peer_peer_t peer

Peer name

relation perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeIdentity remote_peer_inner_ip_address_range [0:*]

other end: perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeIdentity.ipsec_peer [1]

relation perimeta::ipsec_peer::CryptoAlgorithmsProposalIdentity crypto_algorithms_proposal [0:*]

other end: perimeta::ipsec_peer::CryptoAlgorithmsProposalIdentity.ipsec_peer [1]

The following implementations are defined for this entity:

• perimeta::ipsec_peer::ipsec_peer_uri

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::ipsec_peer_uri constraint true

entity perimeta::ipsec_peer::IpsecPeerUnmanaged

Parents: perimeta::ipsec_peer::IpsecPeerIdentity

Unmanaged reference to a /ipsec-peer Perimeta API resource.

Configuration mode for a connection to an IPsec peer. For more information on IPsec peers, see IPsec support in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/V4.6/ConfigurationAndInterop/Source/Perimeta/Concepts/IPsec.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::ipsec_peer::RemotePeerInnerIpAddressRange

Parents: perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeIdentity, std::PurgeableResource

Inmanta resource to manage a /ipsec-peer/remote-peer-inner-ip-address-range Perimeta API resource.

Sets a range of remote IP addresses contactable on this peer. You cannot change this setting while the peer is active. If you use this command to set a remote address range using a different addressing scheme (IPv4 or IPv6) to the address configured with the signaling-local-address command, that command will be reset to an all-zero address using the same addressing scheme as the remote address range.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::ipsec_peer::remote_peer_inner_ip_address_range_config

• perimeta::ipsec_peer::remote_peer_inner_ip_address_range_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::remote_peer_inner_ip_address_range_config, perimeta::ipsec_peer::remote_peer_inner_ip_address_range_cross_device_relations constraint true

entity perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /ipsec-peer/remote-peer-inner-ip-address-range Perimeta API resource. Abstract base entity. For concrete usage, see children RemotePeerInnerIpAddressRange and RemotePeerInnerIpAddressRangeUnmanaged.

Sets a range of remote IP addresses contactable on this peer. You cannot change this setting while the peer is active. If you use this command to set a remote address range using a different addressing scheme (IPv4 or IPv6) to the address configured with the signaling-local-address command, that command will be reset to an all-zero address using the same addressing scheme as the remote address range.

attribute std::ipv_any_address range_start

IP address

attribute perimeta::ipsec_peer::remote_peer_inner_ip_address_range_prefix_length_t prefix_length

Prefix length

relation perimeta::ipsec_peer::IpsecPeerIdentity ipsec_peer [1]

other end: perimeta::ipsec_peer::IpsecPeerIdentity.remote_peer_inner_ip_address_range [0:*]

The following implementations are defined for this entity:

• perimeta::ipsec_peer::remote_peer_inner_ip_address_range_uri

The following implements statements select implementations for this entity:

• perimeta::ipsec_peer::remote_peer_inner_ip_address_range_uri constraint true

entity perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeUnmanaged

Parents: perimeta::ipsec_peer::RemotePeerInnerIpAddressRangeIdentity

Unmanaged reference to a /ipsec-peer/remote-peer-inner-ip-address-range Perimeta API resource.

Sets a range of remote IP addresses contactable on this peer. You cannot change this setting while the peer is active. If you use this command to set a remote address range using a different addressing scheme (IPv4 or IPv6) to the address configured with the signaling-local-address command, that command will be reset to an all-zero address using the same addressing scheme as the remote address range.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::media_address::Ip

Parents: perimeta::media_address::IpIdentity, std::PurgeableResource

Inmanta resource to manage a /media-address/ip Perimeta API resource.

Configuration mode for a media address using a single IP address. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::media_address::ip_realm_t? realm=null

Sets the media realm for this address. This is a text string used to associate the address with an adjacency. It is not case sensitive. It is only required on an MSC or (on an ISC) if the media address will be used with endpoints in an adjacency on a different service network.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::media_address::ip_config

• perimeta::media_address::ip_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::media_address::ip_config, perimeta::media_address::ip_cross_device_relations constraint true

entity perimeta::media_address::IpIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /media-address/ip Perimeta API resource. Abstract base entity. For concrete usage, see children Ip and IpUnmanaged.

Configuration mode for a media address using a single IP address. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

attribute std::ipv_any_address ip

The media IP address on the Session Controller. Can be IPv4 or IPv6.

attribute perimeta::media_address::ip_service_network_t service_network

The service network ID for the service network that is used by the media address.

relation perimeta::media_address::IpPortRangeIdentity port_range [0:*]

other end: perimeta::media_address::IpPortRangeIdentity.ip [1]

The following implementations are defined for this entity:

• perimeta::media_address::ip_uri

The following implements statements select implementations for this entity:

• perimeta::media_address::ip_uri constraint true

entity perimeta::media_address::IpPortRange

Parents: perimeta::media_address::IpPortRangeIdentity, std::PurgeableResource

Inmanta resource to manage a /media-address/ip/port-range Perimeta API resource.

Sets a limited range of permitted ports for use with this address. You can optionally specify a particular class of service for which the Session Controller will use these ports.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::media_address::ip_port_range_class_of_service_t? class_of_service=null

Sets the class of service for which the Session Controller will use this port range.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::media_address::ip_port_range_config

• perimeta::media_address::ip_port_range_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::media_address::ip_port_range_config, perimeta::media_address::ip_port_range_cross_device_relations constraint true

entity perimeta::media_address::IpPortRangeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /media-address/ip/port-range Perimeta API resource. Abstract base entity. For concrete usage, see children IpPortRange and IpPortRangeUnmanaged.

Sets a limited range of permitted ports for use with this address. You can optionally specify a particular class of service for which the Session Controller will use these ports.

attribute perimeta::media_address::ip_port_range_min_port_t min_port

Minimum port in the range 16384

attribute perimeta::media_address::ip_port_range_max_port_t max_port

Maximum port in the range 65535

relation perimeta::media_address::IpIdentity ip [1]

other end: perimeta::media_address::IpIdentity.port_range [0:*]

The following implementations are defined for this entity:

• perimeta::media_address::ip_port_range_uri

The following implements statements select implementations for this entity:

• perimeta::media_address::ip_port_range_uri constraint true

entity perimeta::media_address::IpPortRangeUnmanaged

Parents: perimeta::media_address::IpPortRangeIdentity

Unmanaged reference to a /media-address/ip/port-range Perimeta API resource.

Sets a limited range of permitted ports for use with this address. You can optionally specify a particular class of service for which the Session Controller will use these ports.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::media_address::IpUnmanaged

Parents: perimeta::media_address::IpIdentity

Unmanaged reference to a /media-address/ip Perimeta API resource.

Configuration mode for a media address using a single IP address. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::media_address::Pool

Parents: perimeta::media_address::PoolIdentity, std::PurgeableResource

Inmanta resource to manage a /media-address/pool Perimeta API resource.

Configuration mode for an IP media address pool, which is a continuous range of media addresses. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address pool. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::media_address::pool_realm_t? realm=null

Sets the media realm for this media address pool. This is a text string used to associate the media address pool with an adjacency. It is not case sensitive. It is only required on an MSC or (on an ISC) if the media address will be used with endpoints in an adjacency on a different service network.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::media_address::pool_config

• perimeta::media_address::pool_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::media_address::pool_config, perimeta::media_address::pool_cross_device_relations constraint true

entity perimeta::media_address::PoolIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /media-address/pool Perimeta API resource. Abstract base entity. For concrete usage, see children Pool and PoolUnmanaged.

Configuration mode for an IP media address pool, which is a continuous range of media addresses. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address pool. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

attribute std::ipv_any_address ip_start

Specifies the first IP address in the media address pool. Can be IPv4 or IPv6.

attribute std::ipv_any_address ip_end

Specifies the last IP address in the media address pool. Can be IPv4 or IPv6.

attribute perimeta::media_address::pool_service_network_t service_network

The service network ID for the service network that is used by the media address pool.

relation perimeta::media_address::PoolPortRangeIdentity port_range [0:*]

other end: perimeta::media_address::PoolPortRangeIdentity.pool [1]

The following implementations are defined for this entity:

• perimeta::media_address::pool_uri

The following implements statements select implementations for this entity:

• perimeta::media_address::pool_uri constraint true

entity perimeta::media_address::PoolPortRange

Parents: perimeta::media_address::PoolPortRangeIdentity, std::PurgeableResource

Inmanta resource to manage a /media-address/pool/port-range Perimeta API resource.

Sets a limited range of permitted ports for use with this media address pool. You can optionally specify a particular class of service for which the Session Controller will use these ports.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::media_address::pool_port_range_class_of_service_t? class_of_service=null

Sets the class of service for which the Session Controller will use this port range.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::media_address::pool_port_range_config

• perimeta::media_address::pool_port_range_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::media_address::pool_port_range_config, perimeta::media_address::pool_port_range_cross_device_relations constraint true

entity perimeta::media_address::PoolPortRangeIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /media-address/pool/port-range Perimeta API resource. Abstract base entity. For concrete usage, see children PoolPortRange and PoolPortRangeUnmanaged.

Sets a limited range of permitted ports for use with this media address pool. You can optionally specify a particular class of service for which the Session Controller will use these ports.

attribute perimeta::media_address::pool_port_range_min_port_t min_port

Minimum port in the range 16384

attribute perimeta::media_address::pool_port_range_max_port_t max_port

Maximum port in the range 65535

relation perimeta::media_address::PoolIdentity pool [1]

other end: perimeta::media_address::PoolIdentity.port_range [0:*]

The following implementations are defined for this entity:

• perimeta::media_address::pool_port_range_uri

The following implements statements select implementations for this entity:

• perimeta::media_address::pool_port_range_uri constraint true

entity perimeta::media_address::PoolPortRangeUnmanaged

Parents: perimeta::media_address::PoolPortRangeIdentity

Unmanaged reference to a /media-address/pool/port-range Perimeta API resource.

Sets a limited range of permitted ports for use with this media address pool. You can optionally specify a particular class of service for which the Session Controller will use these ports.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::media_address::PoolUnmanaged

Parents: perimeta::media_address::PoolIdentity

Unmanaged reference to a /media-address/pool Perimeta API resource.

Configuration mode for an IP media address pool, which is a continuous range of media addresses. Media addresses are the IP addresses exposed by the Session Controller for the purpose of relaying media traffic. You must also specify the service network on which the Session Controller must use this media address pool. For more information, see Media addresses and gates in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MediaAddressesAndGates.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::media_realm_group::MediaRealmGroup

Parents: perimeta::media_realm_group::MediaRealmGroupIdentity, std::PurgeableResource

Inmanta resource to manage a /media-realm-group Perimeta API resource.

Configuration mode for the media realm fallback group, which is used to specify a set of mutually reachable media realms, allowing calls to fall back to non-optimal MSCs when no MSCs in the correct location are available. For details see MSC fallback in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSCFallback.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::media_realm_group::media_realm_group_config

• perimeta::media_realm_group::media_realm_group_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::media_realm_group::media_realm_group_config, perimeta::media_realm_group::media_realm_group_cross_device_relations constraint true

entity perimeta::media_realm_group::MediaRealmGroupIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /media-realm-group Perimeta API resource. Abstract base entity. For concrete usage, see children MediaRealmGroup and MediaRealmGroupUnmanaged.

Configuration mode for the media realm fallback group, which is used to specify a set of mutually reachable media realms, allowing calls to fall back to non-optimal MSCs when no MSCs in the correct location are available. For details see MSC fallback in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSCFallback.html).

attribute perimeta::media_realm_group::media_realm_group_media_realm_group_t media_realm_group

The name of the group

The following implementations are defined for this entity:

• perimeta::media_realm_group::media_realm_group_uri

The following implements statements select implementations for this entity:

• perimeta::media_realm_group::media_realm_group_uri constraint true

entity perimeta::media_realm_group::MediaRealmGroupUnmanaged

Parents: perimeta::media_realm_group::MediaRealmGroupIdentity

Unmanaged reference to a /media-realm-group Perimeta API resource.

Configuration mode for the media realm fallback group, which is used to specify a set of mutually reachable media realms, allowing calls to fall back to non-optimal MSCs when no MSCs in the correct location are available. For details see MSC fallback in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/MSCFallback.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::peer_group_sip::Peer

Parents: perimeta::peer_group_sip::PeerIdentity, std::PurgeableResource

Inmanta resource to manage a /peer-group-sip/peer Perimeta API resource.

This Resource represents a single peer in a locally-configured peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests to a peer group.

You must configure a peer Resource for each peer in the locally-configured peer group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

For more information on peer groups and how to configure them, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html) and Configuring a peer group in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPeerGroup.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute std::ipv_any_address ip_address

attribute perimeta::peer_group_sip::peer_port_t? port=null

Specifies the port on the peer to which the Session Controller must connect.

attribute bool? trust=null

Trust traffic from this peer

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::peer_group_sip::peer_config

• perimeta::peer_group_sip::peer_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::peer_group_sip::peer_config, perimeta::peer_group_sip::peer_cross_device_relations constraint true

entity perimeta::peer_group_sip::PeerGroupSip

Parents: perimeta::peer_group_sip::PeerGroupSipIdentity, std::PurgeableResource

Inmanta resource to manage a /peer-group-sip Perimeta API resource.

Configuration mode for a peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests towards this peer group.

Peer groups can be either locally-configured or DNS-configured.

• For a locally-configured peer group, you will configure the Session Controller with the IP address of each peer in the group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

• For a DNS-configured peer group, you will configure the Session Controller with a hostname that returns a set of DNS records containing details of all of the peers in the peer group. The Session Controller will determine the order in which to send requests to these peers according to RFC 3263.

For more information on peer groups, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::peer_group_sip::peer_group_sip_description_t? description=null

Sets a description for this peer group. The description is used only for clarity when viewing information about the peer group.

attribute perimeta::peer_group_sip::peer_group_sip_service_network_t service_network

Specifies the ID number of the service network in which all of the addresses in the peer group are contained.

attribute bool? use_dns_peering=null

Specifies whether this peer group is a DNS-configured group. - Setting this Property to true will configure this peer group as a DNS-configured peer group. The Session Controller will retrieve details of the epers in the peer group by performing a DNS query on the hostname specified in the peer-hostname Property. - Setting this Property to false will configure this peer group as a locally-configured peer group. The Session Controller will retrieve details of the peers in the peer group from the child peer Resources of this peer-group-sip Resource.

attribute perimeta::peer_group_sip::peer_group_sip_peer_hostname_t? peer_hostname=null

Specifies the hostname the Session Controller must use to retrieve a set of DNS records containing details of all of the peers in the peer group.

attribute perimeta::peer_group_sip::peer_group_sip_dns_peer_address_type_t? dns_peer_address_type=null

Specifies the IP version of the addresses that the Session Controller must use for peers in this peer group. The Session Controller will ignore DNS records that resolve to IP addresses of a different version.

attribute perimeta::peer_group_sip::peer_group_sip_dns_peer_port_source_t? dns_peer_port_source=null

Specifies how the Session Controller will determine which port to connect to on peers in this peer group.

attribute perimeta::peer_group_sip::peer_group_sip_dns_port_t? dns_port=null

Specifies the port on peers in this peer group to which the Session Controller must connect.

attribute perimeta::peer_group_sip::peer_group_sip_options_ping_t? options_ping=null

Specifies whether peer availability detection is enabled for the peer group.

attribute perimeta::peer_group_sip::peer_group_sip_options_ping_mechanism_t? options_ping_mechanism=null

Specifies the mechanism the Session Controller will use when monitoring the availability of peers in this peer group. You can choose between the following mechanisms. - Continuous - The Session Controller will only use responses to SIP OPTIONS requests to identify whether peers are available. It will always send a SIP OPTIONS request at the end of the configured interval, regardless of the traffic that it receives from the peer. - Pause during traffic - The Session Controller will use responses to both SIP OPTIONS requests and other SIP traffic to determine whether peers available. As with continuous polling, the Session Controller will send a SIP OPTIONS request at the end of a configurable interval. However, if the Session Controller receives a message of either of the following types from a peer before the interval ends, it will treat this message as an indication that the connection to the peer is still live and will restart the interval without sending a SIP OPTIONS request. - A SIP request - A SIP response to a request (other than a SIP OPTIONS request) with a response code that is included on the list of codes configured to be treated as successes using the non-options-ping-response command. - Traffic only- The Session Controller will only use SIP traffic failures to determine whether peers are available. Unlike pause during traffic, the Session Controller will never send a SIP OPTIONS request to determine if the peer is avaialble. The Session Controller considers peers to be available by default. If the peer is detected as unavailable, the Session Controller stops sending traffic to it. The Session Controller will retry monitoring the availability of the peer when a configurable timer expires. This timer starts each time a peer is marked as unavailable. If the Session Controller receives a request or successful response from the peer, it is marked as available again. We strongly recommend that you do not use the pause during traffic or traffic only mechanisms if peers in this peer group are known to handle large amounts of traffic that is prone to short bursts of failures. If the pause during traffic or traffic only mechanisms are used with this type of peer, a short burst of failure responses to normal SIP traffic would cause the Session Controller to mark the connection to a peer as having failed, even though short bursts of failures are expected behavior and not an indication of a failed connection. This will result in the connection to the peer repeatedly moving between a healthy and a failed state. We strongly recommend that you do not use the traffic only mechanism, unless is it is known that some peers do not support OPTIONS polling.

attribute perimeta::peer_group_sip::peer_group_sip_options_ping_response_t? options_ping_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the options-ping-response-success-codes to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the options-ping-response-failure-codes to specify your chosen list of response codes. This option does not apply to the traffic only mechanism.

attribute perimeta::peer_group_sip::peer_group_sip_options_ping_response_success_codes_t? options_ping_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::peer_group_sip::peer_group_sip_options_ping_response_failure_codes_t? options_ping_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::peer_group_sip::peer_group_sip_other_sip_response_t? other_sip_response=null

Allows you to specify a list of response codes and / or code ranges that will be treated by the Session Controller as either successes or failures when received in response to a request other than a SIP OPTIONS request. If you want to specify a list of response codes that will be treated as successes, you must set this Property to define-success-response-codes and use the other-sip-response-success-codes Property to specify your chosen list of response codes. If you want to specify a list of response codes that will be treated as failures, you must set this Property to define-failure-response-codes and use the other-sip-response-failure-codes Property to specify your chosen list of response codes.

attribute perimeta::peer_group_sip::peer_group_sip_other_sip_response_success_codes_t? other_sip_response_success_codes=null

Specifies a list of codes and / or code ranges that will be treated as successes when received in response to a request other than a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 200-299,404). All of your chosen codes must be in the range 200-699 and the range 200-299 must be included.

attribute perimeta::peer_group_sip::peer_group_sip_other_sip_response_failure_codes_t? other_sip_response_failure_codes=null

Specifies a list of codes and / or code ranges that will be treated as failures when received in response to a request other than a SIP OPTIONS request. You must specify the list of codes and code ranges as a comma-separated list, with code ranges specified by entering the first and last codes in the range separated by a hyphen (e.g. 300-399,404). All of your chosen codes must be in the range 300-699.

attribute perimeta::peer_group_sip::peer_group_sip_failure_threshold_t? failure_threshold=null

The number of consecutive failures necessary for the Session Controller to treat a connection as having failed. The Session Controller will register a failure in the following circumstances. - The Session Controller does not receive a response to a SIP OPTIONS request from the static signaling peer within the configured interval. - The Session Controller receives a response from the static signaling peer to a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the options-ping-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the options-ping-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will identify any response with a 3XX response code as a failure. - (Pause during traffic and traffic only mechanisms only) The Session Controller receives a response from the static signaling peer to any SIP request other than a SIP OPTIONS request with a response code that the Session Controller identifies as a failure. - If you have configured a specific list of response codes using the other-sip-response-failure-codes Property, the Session Controller will identify any response with a code in this list as a failure. - If you have configured a specific list of response codes using the other-sip-response-success-codes Property, the Session Controller will identify any response with a code that is not in this list as a failure. - If you have not set a value for either of these Properties, the Session Controller will not identify any response codes as failures.

attribute perimeta::peer_group_sip::peer_group_sip_interval_t? interval=null

Sets the interval (in seconds) between sending SIP OPTIONS pings. This option does not apply to the traffic only mechanism.

attribute perimeta::peer_group_sip::peer_group_sip_lifetime_t? lifetime=null

Sets the time (in seconds) the Session Controller must wait for a response to a SIP OPTIONS ping before treating it as a failure. This option does not apply to the traffic only mechanism.

attribute perimeta::peer_group_sip::peer_group_sip_max_forwards_t? max_forwards=null

Sets the value that the Session Controller must use for the Max-Forwards header on the SIP OPTIONS pings that it generates. This option does not apply to the traffic only mechanism.

attribute perimeta::peer_group_sip::peer_group_sip_retry_delay_t? retry_delay=null

Sets the retry delay (in seconds) that the Session Controller must wait before sending SIP messages to an unavailable peer. This option only applies to the traffic only mechanism.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::peer_group_sip::peer_group_sip_config

• perimeta::peer_group_sip::peer_group_sip_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::peer_group_sip::peer_group_sip_config, perimeta::peer_group_sip::peer_group_sip_cross_device_relations constraint true

entity perimeta::peer_group_sip::PeerGroupSipIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /peer-group-sip Perimeta API resource. Abstract base entity. For concrete usage, see children PeerGroupSip and PeerGroupSipUnmanaged.

Configuration mode for a peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests towards this peer group.

Peer groups can be either locally-configured or DNS-configured.

• For a locally-configured peer group, you will configure the Session Controller with the IP address of each peer in the group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

• For a DNS-configured peer group, you will configure the Session Controller with a hostname that returns a set of DNS records containing details of all of the peers in the peer group. The Session Controller will determine the order in which to send requests to these peers according to RFC 3263.

For more information on peer groups, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html).

attribute perimeta::peer_group_sip::peer_group_sip_peer_group_name_t peer_group_name

Specifies a name for this peer group.

relation perimeta::peer_group_sip::PeerIdentity peer [0:*]

other end: perimeta::peer_group_sip::PeerIdentity.peer_group_sip [1]

The following implementations are defined for this entity:

• perimeta::peer_group_sip::peer_group_sip_uri

The following implements statements select implementations for this entity:

• perimeta::peer_group_sip::peer_group_sip_uri constraint true

entity perimeta::peer_group_sip::PeerGroupSipUnmanaged

Parents: perimeta::peer_group_sip::PeerGroupSipIdentity

Unmanaged reference to a /peer-group-sip Perimeta API resource.

Configuration mode for a peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests towards this peer group.

Peer groups can be either locally-configured or DNS-configured.

• For a locally-configured peer group, you will configure the Session Controller with the IP address of each peer in the group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

• For a DNS-configured peer group, you will configure the Session Controller with a hostname that returns a set of DNS records containing details of all of the peers in the peer group. The Session Controller will determine the order in which to send requests to these peers according to RFC 3263.

For more information on peer groups, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::peer_group_sip::PeerIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /peer-group-sip/peer Perimeta API resource. Abstract base entity. For concrete usage, see children Peer and PeerUnmanaged.

This Resource represents a single peer in a locally-configured peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests to a peer group.

You must configure a peer Resource for each peer in the locally-configured peer group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

For more information on peer groups and how to configure them, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html) and Configuring a peer group in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPeerGroup.html).

attribute perimeta::peer_group_sip::peer_peer_name_t peer_name

Specifies a name for this peer.

relation perimeta::peer_group_sip::PeerGroupSipIdentity peer_group_sip [1]

other end: perimeta::peer_group_sip::PeerGroupSipIdentity.peer [0:*]

The following implementations are defined for this entity:

• perimeta::peer_group_sip::peer_uri

The following implements statements select implementations for this entity:

• perimeta::peer_group_sip::peer_uri constraint true

entity perimeta::peer_group_sip::PeerUnmanaged

Parents: perimeta::peer_group_sip::PeerIdentity

Unmanaged reference to a /peer-group-sip/peer Perimeta API resource.

This Resource represents a single peer in a locally-configured peer group. Peer groups allow you to configure multiple signaling peers as a single configuration object. You can configure one or more adjacencies to forward requests to a peer group.

You must configure a peer Resource for each peer in the locally-configured peer group. The Session Controller will randomly distribute requests between these peers, with each peer being given an equal weighting.

For more information on peer groups and how to configure them, see Peer groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PeerGroups.html) and Configuring a peer group in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAPeerGroup.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::priority_call_media_limit::PriorityCallMediaLimit

Parents: perimeta::priority_call_media_limit::PriorityCallMediaLimitIdentity, std::PurgeableResource

Inmanta resource to manage a /priority-call-media-limit Perimeta API resource.

Specifies a limit on calls with a specified priority or a lower priority on MSCs connected to this Session Controller based on the percentage of media capacity in use. This allows you to ensure that connected MSCs will reject new lower-priority calls to allow emergency or other high priority-calls to be connected.

For more information, see Disabling emergency call pre-emption and ensuring connected MSCs can handle emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/DisablingEmergencyCallPreEmption.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::priority_call_media_limit::priority_call_media_limit_occupancy_limit_t occupancy_limit

The percentage of media capacity in use at which a connected MSC will stop accepting calls with the specified priority or a lower priority and this Session Controller will stop sending such calls to the connected MSC

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::priority_call_media_limit::priority_call_media_limit_config

• perimeta::priority_call_media_limit::priority_call_media_limit_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::priority_call_media_limit::priority_call_media_limit_config, perimeta::priority_call_media_limit::priority_call_media_limit_cross_device_relations constraint true

entity perimeta::priority_call_media_limit::PriorityCallMediaLimitIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /priority-call-media-limit Perimeta API resource. Abstract base entity. For concrete usage, see children PriorityCallMediaLimit and PriorityCallMediaLimitUnmanaged.

Specifies a limit on calls with a specified priority or a lower priority on MSCs connected to this Session Controller based on the percentage of media capacity in use. This allows you to ensure that connected MSCs will reject new lower-priority calls to allow emergency or other high priority-calls to be connected.

For more information, see Disabling emergency call pre-emption and ensuring connected MSCs can handle emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/DisablingEmergencyCallPreEmption.html).

attribute perimeta::priority_call_media_limit::priority_call_media_limit_maximum_call_priority_t maximum_call_priority

The highest call priority this limit applies to

The following implementations are defined for this entity:

• perimeta::priority_call_media_limit::priority_call_media_limit_uri

The following implements statements select implementations for this entity:

• perimeta::priority_call_media_limit::priority_call_media_limit_uri constraint true

entity perimeta::priority_call_media_limit::PriorityCallMediaLimitUnmanaged

Parents: perimeta::priority_call_media_limit::PriorityCallMediaLimitIdentity

Unmanaged reference to a /priority-call-media-limit Perimeta API resource.

Specifies a limit on calls with a specified priority or a lower priority on MSCs connected to this Session Controller based on the percentage of media capacity in use. This allows you to ensure that connected MSCs will reject new lower-priority calls to allow emergency or other high priority-calls to be connected.

For more information, see Disabling emergency call pre-emption and ensuring connected MSCs can handle emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/DisablingEmergencyCallPreEmption.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::priority_category::PriorityCategory

Parents: perimeta::priority_category::PriorityCategoryIdentity, std::PurgeableResource

Inmanta resource to manage a /priority-category Perimeta API resource.

Configures a priority category to apply to high-priority calls such as emergency calls. Priority categories allow you to control how the Session Controller handles high-priority calls such as emergency calls.

You can configure rules that assign a priority category to INVITEs or responses to INVITEs with a specified Resource Priority header that are received on a core adjacency or that have particular digits or usernames in the Request-URI. You can then:

• Configure a priority for each rule, which the Session Controller uses to prioritize the call internally and, if you have configured a connection to a PCRF, to program the PCRF to reserve media resources (by sending the priority in a Reservation-Priority AVP).

• If you have configured a rule that matches on digits or usernames in the Request-URI, add a Resource Priority header to the message when the Session Controller forwards it.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::priority_category::priority_category_call_limit_bypass_t? call_limit_bypass=null

Set whether calls in this category are affected by call limits

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::priority_category::priority_category_config

• perimeta::priority_category::priority_category_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::priority_category::priority_category_config, perimeta::priority_category::priority_category_cross_device_relations constraint true

entity perimeta::priority_category::PriorityCategoryIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /priority-category Perimeta API resource. Abstract base entity. For concrete usage, see children PriorityCategory and PriorityCategoryUnmanaged.

Configures a priority category to apply to high-priority calls such as emergency calls. Priority categories allow you to control how the Session Controller handles high-priority calls such as emergency calls.

You can configure rules that assign a priority category to INVITEs or responses to INVITEs with a specified Resource Priority header that are received on a core adjacency or that have particular digits or usernames in the Request-URI. You can then:

• Configure a priority for each rule, which the Session Controller uses to prioritize the call internally and, if you have configured a connection to a PCRF, to program the PCRF to reserve media resources (by sending the priority in a Reservation-Priority AVP).

• If you have configured a rule that matches on digits or usernames in the Request-URI, add a Resource Priority header to the message when the Session Controller forwards it.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

attribute perimeta::priority_category::priority_category_sip_priority_category_t sip_priority_category

Priority category to assign. Available categories: - cat.sbc.anonymous - anonymous calls - cat.sbc.emergency - emergency calls - cat.sbc.recorded - calls that should be recorded - cat.sbc.redirected - redirected calls - cat.custom.customCategoryName - custom categories. customCategoryName can be up to 19 alphanumeric characters.

relation perimeta::priority_category::ResourcePriorityHeaderMatchIdentity resource_priority_header_match [0:*]

other end: perimeta::priority_category::ResourcePriorityHeaderMatchIdentity.priority_category [1]

relation perimeta::priority_category::RnPatternMatchIdentity rn_pattern_match [0:*]

other end: perimeta::priority_category::RnPatternMatchIdentity.priority_category [1]

relation perimeta::priority_category::UriPatternMatchIdentity uri_pattern_match [0:*]

other end: perimeta::priority_category::UriPatternMatchIdentity.priority_category [1]

The following implementations are defined for this entity:

• perimeta::priority_category::priority_category_uri

The following implements statements select implementations for this entity:

• perimeta::priority_category::priority_category_uri constraint true

entity perimeta::priority_category::PriorityCategoryUnmanaged

Parents: perimeta::priority_category::PriorityCategoryIdentity

Unmanaged reference to a /priority-category Perimeta API resource.

Configures a priority category to apply to high-priority calls such as emergency calls. Priority categories allow you to control how the Session Controller handles high-priority calls such as emergency calls.

You can configure rules that assign a priority category to INVITEs or responses to INVITEs with a specified Resource Priority header that are received on a core adjacency or that have particular digits or usernames in the Request-URI. You can then:

• Configure a priority for each rule, which the Session Controller uses to prioritize the call internally and, if you have configured a connection to a PCRF, to program the PCRF to reserve media resources (by sending the priority in a Reservation-Priority AVP).

• If you have configured a rule that matches on digits or usernames in the Request-URI, add a Resource Priority header to the message when the Session Controller forwards it.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::priority_category::ResourcePriorityHeaderMatch

Parents: perimeta::priority_category::ResourcePriorityHeaderMatchIdentity, std::PurgeableResource

Inmanta resource to manage a /priority-category/resource-priority-header-match Perimeta API resource.

Specifies a rule for applying the priority category based on the Resource Priority header on INVITEs or responses to INVITEs.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::priority_category::resource_priority_header_match_priority_level_t priority_level

Sets a priority value to apply to calls that match the parent rule for applying a priority category. The Session Controller uses this to prioritize calls internally. If you have configured a connection to a PCRF, the Session Controller sends the priority value in a Reservation-Priority AVP in an AAR or preliminary AAR, so the PCRF can prioritize resources for the call. A higher value indicates a higher priority. Default priorities: - Standard call: 1 - Call with the cat.sbc.emergency category applied: 6

attribute perimeta::priority_category::resource_priority_header_match_remove_resource_priority_header_t? remove_resource_priority_header=null

Removes the Resource Priority header from calls.

attribute perimeta::priority_category::resource_priority_header_match_priority_statistics_group_t? priority_statistics_group=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool? priority_statistics_group_use_default=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::priority_category::resource_priority_header_match_config

• perimeta::priority_category::resource_priority_header_match_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::priority_category::resource_priority_header_match_config, perimeta::priority_category::resource_priority_header_match_cross_device_relations constraint true

entity perimeta::priority_category::ResourcePriorityHeaderMatchIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /priority-category/resource-priority-header-match Perimeta API resource. Abstract base entity. For concrete usage, see children ResourcePriorityHeaderMatch and ResourcePriorityHeaderMatchUnmanaged.

Specifies a rule for applying the priority category based on the Resource Priority header on INVITEs or responses to INVITEs.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

attribute perimeta::priority_category::resource_priority_header_match_resource_priority_header_t resource_priority_header

Resource Priority header to match. This must be in the form string1 . string2 and up to 64 characters in length.

relation perimeta::priority_category::PriorityCategoryIdentity priority_category [1]

other end: perimeta::priority_category::PriorityCategoryIdentity.resource_priority_header_match [0:*]

The following implementations are defined for this entity:

• perimeta::priority_category::resource_priority_header_match_uri

The following implements statements select implementations for this entity:

• perimeta::priority_category::resource_priority_header_match_uri constraint true

entity perimeta::priority_category::ResourcePriorityHeaderMatchUnmanaged

Parents: perimeta::priority_category::ResourcePriorityHeaderMatchIdentity

Unmanaged reference to a /priority-category/resource-priority-header-match Perimeta API resource.

Specifies a rule for applying the priority category based on the Resource Priority header on INVITEs or responses to INVITEs.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::priority_category::RnPatternMatch

Parents: perimeta::priority_category::RnPatternMatchIdentity, std::PurgeableResource

Inmanta resource to manage a /priority-category/rn-pattern-match Perimeta API resource.

Specifies a rule for applying the priority category based on the routing number (rn) parameter in the SIP INVITE Request-URI. You can use a fixed length match (where the routing number matches the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::priority_category::rn_pattern_match_priority_level_t priority_level

Sets a priority value to apply to calls. The Session Controller uses this to prioritize calls internally. If you have configured a connection to a PCRF, the Session Controller sends the priority value in a Reservation-Priority AVP in an AAR or preliminary AAR, so the PCRF can prioritize resources for the call. A higher value indicates a higher priority. Default priorities: - Standard call: 1 - Call with the cat.sbc.emergency category applied: 6

attribute perimeta::priority_category::rn_pattern_match_resource_priority_header_t? resource_priority_header=null

Sets an optional Resource Priority header to add to calls that match this rule. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::priority_category::rn_pattern_match_priority_statistics_group_t? priority_statistics_group=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool? priority_statistics_group_use_default=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::priority_category::rn_pattern_match_config

• perimeta::priority_category::rn_pattern_match_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::priority_category::rn_pattern_match_config, perimeta::priority_category::rn_pattern_match_cross_device_relations constraint true

entity perimeta::priority_category::RnPatternMatchIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /priority-category/rn-pattern-match Perimeta API resource. Abstract base entity. For concrete usage, see children RnPatternMatch and RnPatternMatchUnmanaged.

Specifies a rule for applying the priority category based on the routing number (rn) parameter in the SIP INVITE Request-URI. You can use a fixed length match (where the routing number matches the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

attribute perimeta::priority_category::rn_pattern_match_match_rn_t match_rn

Specifies the contents of the rn parameter of the Request-URI to match, as an exact match or a prefix match. A prefix match uses wildcards to match any string starting with the specified characters. You can match strings of any length by putting .* at the end of the characters you want to match or specify the number of additional characters by using one . for each character. For example, 710.* matches any dialed number starting with 710, but 710……. matches any dialed number starting with 710 and containing exactly 7 other characters. A character class matches any of the characters in the class, for example 7[1-4]0 matches any of 710, 712, 713, 714. A character class may optionally have an interval quantifier after it, for example 7[1-4]{2} or 7[1-4]{2,3}. You can combine character classes with wildcards and/or prefixes. You do not need to enter sip:, sips: or tel:. If you need to match ., *, [, ], {, } or as literal characters (instead of special characters), you must escape them with .

relation perimeta::priority_category::PriorityCategoryIdentity priority_category [1]

other end: perimeta::priority_category::PriorityCategoryIdentity.rn_pattern_match [0:*]

The following implementations are defined for this entity:

• perimeta::priority_category::rn_pattern_match_uri

The following implements statements select implementations for this entity:

• perimeta::priority_category::rn_pattern_match_uri constraint true

entity perimeta::priority_category::RnPatternMatchUnmanaged

Parents: perimeta::priority_category::RnPatternMatchIdentity

Unmanaged reference to a /priority-category/rn-pattern-match Perimeta API resource.

Specifies a rule for applying the priority category based on the routing number (rn) parameter in the SIP INVITE Request-URI. You can use a fixed length match (where the routing number matches the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::priority_category::UriPatternMatch

Parents: perimeta::priority_category::UriPatternMatchIdentity, std::PurgeableResource

Inmanta resource to manage a /priority-category/uri-pattern-match Perimeta API resource.

Specifies a rule for applying the priority category based on the digits or username in the SIP INVITE Request-URI. You can use a fixed length match (where the digits or username match the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::priority_category::uri_pattern_match_priority_level_t priority_level

Sets a priority value to apply to calls. The Session Controller uses this to prioritize calls internally. If you have configured a connection to a PCRF, the Session Controller sends the priority value in a Reservation-Priority AVP in an AAR or preliminary AAR, so the PCRF can prioritize resources for the call. A higher value indicates a higher priority. Default priorities: - Standard call: 1 - Call with the cat.sbc.emergency category applied: 6

attribute perimeta::priority_category::uri_pattern_match_resource_priority_header_t? resource_priority_header=null

Sets an optional Resource Priority header to add to calls that match this rule. For more information, see Categorizing calls as emergency or high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/CategorizingCallsAsEmergencyOrGETSCalls.html).

attribute perimeta::priority_category::uri_pattern_match_priority_statistics_group_t? priority_statistics_group=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool? priority_statistics_group_use_default=null

Sets a priority statistics group to apply to calls that match the parent rule for applying a priority category. Priority call statistics are produced per group. Calls that match multiple priority category rules can have several priority statistics groups applied and will affect priority call statistics in each of those groups.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::priority_category::uri_pattern_match_config

• perimeta::priority_category::uri_pattern_match_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::priority_category::uri_pattern_match_config, perimeta::priority_category::uri_pattern_match_cross_device_relations constraint true

entity perimeta::priority_category::UriPatternMatchIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /priority-category/uri-pattern-match Perimeta API resource. Abstract base entity. For concrete usage, see children UriPatternMatch and UriPatternMatchUnmanaged.

Specifies a rule for applying the priority category based on the digits or username in the SIP INVITE Request-URI. You can use a fixed length match (where the digits or username match the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

attribute perimeta::priority_category::uri_pattern_match_match_id_t match_id

Specifies the digits or the username in the Request-URI to match, as an exact match, a prefix match or character classes. A prefix match uses wildcards to match any string starting with the specified characters. You can match strings of any length by putting .* at the end of the characters you want to match or specify the number of additional characters by using one . for each character. For example, 710.* matches any dialed number starting with 710, but 710……. matches any dialed number starting with 710 and containing exactly 7 other characters. A character class matches any of the characters in the class, for example 7[1-4]0 matches any of 710, 712, 713, 714. A character class may optionally have an interval quantifier after it, for example 7[1-4]{2} or 7[1-4]{2,3}. You can combine character classes with wildcards and/or prefixes. You do not need to enter sip:, sips: or tel:. If you need to match ., *, [, ], {, } or as literal characters (instead of special characters), you must escape them with .

relation perimeta::priority_category::PriorityCategoryIdentity priority_category [1]

other end: perimeta::priority_category::PriorityCategoryIdentity.uri_pattern_match [0:*]

The following implementations are defined for this entity:

• perimeta::priority_category::uri_pattern_match_uri

The following implements statements select implementations for this entity:

• perimeta::priority_category::uri_pattern_match_uri constraint true

entity perimeta::priority_category::UriPatternMatchUnmanaged

Parents: perimeta::priority_category::UriPatternMatchIdentity

Unmanaged reference to a /priority-category/uri-pattern-match Perimeta API resource.

Specifies a rule for applying the priority category based on the digits or username in the SIP INVITE Request-URI. You can use a fixed length match (where the digits or username match the specified characters and/or character classes) or a prefix match.

For more information, see Emergency and high-priority calls in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/EmergencyCalls.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::push_notification_service::PushNotificationService

Parents: perimeta::push_notification_service::PushNotificationServiceIdentity, std::PurgeableResource

Inmanta resource to manage a /push-notification-service Perimeta API resource.

Creates and names a push notification profile. You can use a push notification profile to connect to a push notification service (PN service). A PN service can wake a sleeping VoIP app endpoint so the app can receive inbound calls and other signaling messages.

The app must indicate that it must be woken by a PN service in the REGISTER messages it sends to your Perimeta Session Controller. When the Session Controller receives an INVITE or out-of-dialog request for the endpoint, it sends a push notification request to the PN service. The PN service then uses a notification to wake the app. The app must send another REGISTER to the Session Controller to indicate that it has woken up. Perimeta then sends the INVITE or out-of-dialog request to the app.

For more information, see Push notification services in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SupportForPushNotificationServices.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::push_notification_service::push_notification_service_service_type_t? service_type=null

Specifies the type of push notification service to use. Perimeta currently supports the Apple Push Notification Service (APNs).

attribute perimeta::push_notification_service::push_notification_service_application_id_t? application_id=null

Specifies the application ID for the endpoint (an app) for this push notification profile.

attribute perimeta::push_notification_service::push_notification_service_service_network_id_t? service_network_id=null

Specifies the ID of the service network used to connect to the push notification service.

attribute perimeta::push_notification_service::push_notification_service_certificate_t? certificate=null

Specifies the application’s push notification certificate for connecting to the push notification service. It can be up to 4000 characters in length. You must provide the certificate in .pem format and include the —–BEGIN CERTIFICATE—– and —–END CERTIFICATE—– lines. If you are using the Apple Push Notification Service, see Obtaining a push notification certificate for the Apple Push Notification Service for Perimeta in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ObtainingACertificateForAPNs.html) for instructions on obtaining the certificate.

attribute perimeta::push_notification_service::push_notification_service_private_key_t? private_key=null

Specifies the private key to use to connect to the push notification service. It must meet the following requirements. - It must be in .pem format. - It can be up to 4096 bits in size. - It can be up to 4000 characters in length. - It can be an RSA or DSA key. - It must begin with a —–BEGIN RSA PRIVATE KEY—– or —–BEGIN DSA PRIVATE KEY—– line. - It must end with an —–END RSA PRIVATE KEY—– or —–END DSA PRIVATE KEY—– line. - It must not be secured with a passphrase. If you are using the Apple Push Notification Service, see Obtaining a push notification certificate for the Apple Push Notification Service for Perimeta in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ObtainingACertificateForAPNs.html) for instructions on obtaining the key.

attribute bool? activate=null

Activates this push notification profile. You must activate the profile to use it for providing push notifications.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::push_notification_service::push_notification_service_config

• perimeta::push_notification_service::push_notification_service_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::push_notification_service::push_notification_service_config, perimeta::push_notification_service::push_notification_service_cross_device_relations constraint true

entity perimeta::push_notification_service::PushNotificationServiceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /push-notification-service Perimeta API resource. Abstract base entity. For concrete usage, see children PushNotificationService and PushNotificationServiceUnmanaged.

Creates and names a push notification profile. You can use a push notification profile to connect to a push notification service (PN service). A PN service can wake a sleeping VoIP app endpoint so the app can receive inbound calls and other signaling messages.

The app must indicate that it must be woken by a PN service in the REGISTER messages it sends to your Perimeta Session Controller. When the Session Controller receives an INVITE or out-of-dialog request for the endpoint, it sends a push notification request to the PN service. The PN service then uses a notification to wake the app. The app must send another REGISTER to the Session Controller to indicate that it has woken up. Perimeta then sends the INVITE or out-of-dialog request to the app.

For more information, see Push notification services in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SupportForPushNotificationServices.html).

attribute perimeta::push_notification_service::push_notification_service_name_t name

Name for the push notification profile

The following implementations are defined for this entity:

• perimeta::push_notification_service::push_notification_service_uri

The following implements statements select implementations for this entity:

• perimeta::push_notification_service::push_notification_service_uri constraint true

entity perimeta::push_notification_service::PushNotificationServiceUnmanaged

Parents: perimeta::push_notification_service::PushNotificationServiceIdentity

Unmanaged reference to a /push-notification-service Perimeta API resource.

Creates and names a push notification profile. You can use a push notification profile to connect to a push notification service (PN service). A PN service can wake a sleeping VoIP app endpoint so the app can receive inbound calls and other signaling messages.

The app must indicate that it must be woken by a PN service in the REGISTER messages it sends to your Perimeta Session Controller. When the Session Controller receives an INVITE or out-of-dialog request for the endpoint, it sends a push notification request to the PN service. The PN service then uses a notification to wake the app. The app must send another REGISTER to the Session Controller to indicate that it has woken up. Perimeta then sends the INVITE or out-of-dialog request to the app.

For more information, see Push notification services in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SupportForPushNotificationServices.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::qos::Msrp

Parents: perimeta::qos::MsrpIdentity, std::PurgeableResource

Inmanta resource to manage a /qos/msrp Perimeta API resource.

Read-only Resource for a QoS profile for the MSRP class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::qos::msrp_config

• perimeta::qos::msrp_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::qos::msrp_config, perimeta::qos::msrp_cross_device_relations constraint true

entity perimeta::qos::MsrpIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /qos/msrp Perimeta API resource. Abstract base entity. For concrete usage, see children Msrp and MsrpUnmanaged.

Read-only Resource for a QoS profile for the MSRP class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

attribute perimeta::qos::msrp_profile_name_t profile_name

Specifies the name of the QoS profile. The profile must have been configured on the Session Controller through the Perimeta CLI.

The following implementations are defined for this entity:

• perimeta::qos::msrp_uri

The following implements statements select implementations for this entity:

• perimeta::qos::msrp_uri constraint true

entity perimeta::qos::MsrpUnmanaged

Parents: perimeta::qos::MsrpIdentity

Unmanaged reference to a /qos/msrp Perimeta API resource.

Read-only Resource for a QoS profile for the MSRP class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::qos::Sig

Parents: perimeta::qos::SigIdentity, std::PurgeableResource

Inmanta resource to manage a /qos/sig Perimeta API resource.

Read-only Resource for a QoS profile for the signaling class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::qos::sig_config

• perimeta::qos::sig_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::qos::sig_config, perimeta::qos::sig_cross_device_relations constraint true

entity perimeta::qos::SigIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /qos/sig Perimeta API resource. Abstract base entity. For concrete usage, see children Sig and SigUnmanaged.

Read-only Resource for a QoS profile for the signaling class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

attribute perimeta::qos::sig_profile_name_t profile_name

Specifies the name of the QoS profile. The profile must have been configured on the Session Controller through the Perimeta CLI.

The following implementations are defined for this entity:

• perimeta::qos::sig_uri

The following implements statements select implementations for this entity:

• perimeta::qos::sig_uri constraint true

entity perimeta::qos::SigUnmanaged

Parents: perimeta::qos::SigIdentity

Unmanaged reference to a /qos/sig Perimeta API resource.

Read-only Resource for a QoS profile for the signaling class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::qos::Video

Parents: perimeta::qos::VideoIdentity, std::PurgeableResource

Inmanta resource to manage a /qos/video Perimeta API resource.

Read-only Resource for a QoS profile for the video class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::qos::video_config

• perimeta::qos::video_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::qos::video_config, perimeta::qos::video_cross_device_relations constraint true

entity perimeta::qos::VideoIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /qos/video Perimeta API resource. Abstract base entity. For concrete usage, see children Video and VideoUnmanaged.

Read-only Resource for a QoS profile for the video class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

attribute perimeta::qos::video_profile_name_t profile_name

Specifies the name of the QoS profile. The profile must have been configured on the Session Controller through the Perimeta CLI.

The following implementations are defined for this entity:

• perimeta::qos::video_uri

The following implements statements select implementations for this entity:

• perimeta::qos::video_uri constraint true

entity perimeta::qos::VideoUnmanaged

Parents: perimeta::qos::VideoIdentity

Unmanaged reference to a /qos/video Perimeta API resource.

Read-only Resource for a QoS profile for the video class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::qos::Voice

Parents: perimeta::qos::VoiceIdentity, std::PurgeableResource

Inmanta resource to manage a /qos/voice Perimeta API resource.

Read-only Resource for a QoS profile for the voice class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::qos::voice_config

• perimeta::qos::voice_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::qos::voice_config, perimeta::qos::voice_cross_device_relations constraint true

entity perimeta::qos::VoiceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /qos/voice Perimeta API resource. Abstract base entity. For concrete usage, see children Voice and VoiceUnmanaged.

Read-only Resource for a QoS profile for the voice class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

attribute perimeta::qos::voice_profile_name_t profile_name

Specifies the name of the QoS profile. The profile must have been configured on the Session Controller through the Perimeta CLI.

The following implementations are defined for this entity:

• perimeta::qos::voice_uri

The following implements statements select implementations for this entity:

• perimeta::qos::voice_uri constraint true

entity perimeta::qos::VoiceUnmanaged

Parents: perimeta::qos::VoiceIdentity

Unmanaged reference to a /qos/voice Perimeta API resource.

Read-only Resource for a QoS profile for the voice class of service. You must configure QoS profiles in the Perimeta CLI. For more information, see Packet marking in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/PacketMarking.html) and Configuring a Quality of Service profile in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringAQualityOfServiceProfile.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::routing::Routing

Parents: perimeta::routing::RoutingIdentity, std::PurgeableResource

Inmanta resource to manage a /routing Perimeta API resource.

The routing Resource allows you to manage global routing configuration for your Session Controller, including the selection of the active call policy set and the maximum limit on routing attempts when performing hunting.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? permit_active_routing_changes=null

Specifies whether administrators are able to add, reconfigure or remove routing policy tables in the active call policy set.

attribute perimeta::routing::routing_max_routing_attempts_t? max_routing_attempts=null

Sets the limit on the number of times the Session Controller will attempt routing for a SIP request. The process of retrying routing is referred to as ‘hunting’ and will only be triggered by specific error codes. You can configure which error codes trigger hunting. For more information, see Routing policy in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RoutingPolicy.html)

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel active_call_policy_set: Sets the active call policy set. You must specify the call policy set by its ID, which is a positive integer. For information on how to configure call policy sets, see Configuring a call policy set in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACallPolicySet.html).

relation perimeta::call_policy_set::CallPolicySetIdentity active_call_policy_set [0:1]

Sets the active call policy set. You must specify the call policy set by its ID, which is a positive integer. For

information on how to configure call policy sets, see Configuring a call policy set in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringACallPolicySet.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::routing::routing_config

• perimeta::routing::routing_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::routing::routing_config, perimeta::routing::routing_cross_device_relations constraint true

entity perimeta::routing::RoutingIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /routing Perimeta API resource. Abstract base entity. For concrete usage, see children Routing and RoutingUnmanaged.

The routing Resource allows you to manage global routing configuration for your Session Controller, including the selection of the active call policy set and the maximum limit on routing attempts when performing hunting.

The following implementations are defined for this entity:

• perimeta::routing::routing_uri

The following implements statements select implementations for this entity:

• perimeta::routing::routing_uri constraint true

entity perimeta::routing::RoutingUnmanaged

Parents: perimeta::routing::RoutingIdentity

Unmanaged reference to a /routing Perimeta API resource.

The routing Resource allows you to manage global routing configuration for your Session Controller, including the selection of the active call policy set and the maximum limit on routing attempts when performing hunting.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::Ipv4

Parents: perimeta::service_interface::Ipv4Identity, std::PurgeableResource

Inmanta resource to manage a /service-interface/ipv4 Perimeta API resource.

Configuration mode for an IPv4 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? activate=null

Activates the IPv4 subnet configuration.

attribute std::ipv4_address gateway_ip_address

Sets the IP address of a default gateway in your network.

attribute perimeta::service_interface::ipv4_gateway_static_mac_address_t? gateway_static_mac_address=null

Provide the static MAC address of the gateway

attribute perimeta::service_interface::ipv4_gateway_static_mac_address_value_t? gateway_static_mac_address_value=null

Set the static MAC address of the gateway IP address. This is only required if the provided gateway does not respond to ARP probes.

attribute perimeta::service_interface::ipv4_subnet_prefix_length_t subnet_prefix_length

Sets the subnet prefix length of the local subnet.

attribute std::ipv4_address? probes_target=null

Sets the target IP address for ARP probing. For example, you can use the IP address of a softswitch in your core service network or a default gateway in your access service network. You must make sure that the address you configure has a low latency from your Session Controller, because a reliable response time of less than 50ms is expected.

attribute perimeta::service_interface::ipv4_probes_source_style_t? probes_source_style=null

Sets the probing source type you want to use for IPv4 ARP probing. For the specific-source type, you must set source IP addresses: - On a high availability system, set four IP addresses. - On a standalone system, set two IP addresses.

attribute std::ipv4_address? probes_source_ip_shelf_A_interface_1=null

The first source address to use on instance A for ARP probes.

attribute std::ipv4_address? probes_source_ip_shelf_A_interface_2=null

The second source address to use on instance A for ARP probes.

attribute std::ipv4_address? probes_source_ip_shelf_B_interface_1=null

The first source address to use on instance B for ARP probes.

attribute std::ipv4_address? probes_source_ip_shelf_B_interface_2=null

The second source address to use on instance B for ARP probes.

attribute std::ipv4_address? probes_source_ip_interface_1=null

The first source address to use on a standalone system for ARP probes.

attribute std::ipv4_address? probes_source_ip_interface_2=null

The second source address to use on a standalone system for ARP probes.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_config

• perimeta::service_interface::ipv4_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_config, perimeta::service_interface::ipv4_cross_device_relations constraint true

entity perimeta::service_interface::Ipv4Identity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface/ipv4 Perimeta API resource. Abstract base entity. For concrete usage, see children Ipv4 and Ipv4Unmanaged.

Configuration mode for an IPv4 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

relation perimeta::service_interface::ServiceInterfaceIdentity service_interface [1]

other end: perimeta::service_interface::ServiceInterfaceIdentity.ipv4 [0:1]

relation perimeta::service_interface::Ipv4PerInstanceAddressIdentity per_instance_address [0:*]

other end: perimeta::service_interface::Ipv4PerInstanceAddressIdentity.ipv4 [1]

relation perimeta::service_interface::Ipv4LocalIpAddressIdentity local_ip_address [0:*]

other end: perimeta::service_interface::Ipv4LocalIpAddressIdentity.ipv4 [1]

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_uri constraint true

entity perimeta::service_interface::Ipv4LocalIpAddress

Parents: perimeta::service_interface::Ipv4LocalIpAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /service-interface/ipv4/local-ip-address Perimeta API resource.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::service_interface::ipv4_local_ip_address_local_ip_address_usage_t? local_ip_address_usage=null

Set whether or not this IP address is an (off-LAN) IP address outside of the subnet.

attribute perimeta::service_interface::ipv4_local_ip_address_service_address_t? service_address=null

Assigns a service address name to this IP address on this service interface. You will use this name to select the address when configuring adjacencies and other configuration objects.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_local_ip_address_config

• perimeta::service_interface::ipv4_local_ip_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_local_ip_address_config, perimeta::service_interface::ipv4_local_ip_address_cross_device_relations constraint true

entity perimeta::service_interface::Ipv4LocalIpAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface/ipv4/local-ip-address Perimeta API resource. Abstract base entity. For concrete usage, see children Ipv4LocalIpAddress and Ipv4LocalIpAddressUnmanaged.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

attribute std::ipv4_address local_ip_address

Sets the local IPv4 address of the service interface.

relation perimeta::service_interface::Ipv4Identity ipv4 [1]

other end: perimeta::service_interface::Ipv4Identity.local_ip_address [0:*]

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_local_ip_address_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_local_ip_address_uri constraint true

entity perimeta::service_interface::Ipv4LocalIpAddressUnmanaged

Parents: perimeta::service_interface::Ipv4LocalIpAddressIdentity

Unmanaged reference to a /service-interface/ipv4/local-ip-address Perimeta API resource.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::Ipv4PerInstanceAddress

Parents: perimeta::service_interface::Ipv4PerInstanceAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /service-interface/ipv4/per-instance-address Perimeta API resource.

Sets a per-instance IPv4 address for this service interface

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute std::ipv_any_address? instance_address_A=null

Instance A

attribute std::ipv_any_address? instance_address_B=null

Instance B

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_per_instance_address_config

• perimeta::service_interface::ipv4_per_instance_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_per_instance_address_config, perimeta::service_interface::ipv4_per_instance_address_cross_device_relations constraint true

entity perimeta::service_interface::Ipv4PerInstanceAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface/ipv4/per-instance-address Perimeta API resource. Abstract base entity. For concrete usage, see children Ipv4PerInstanceAddress and Ipv4PerInstanceAddressUnmanaged.

Sets a per-instance IPv4 address for this service interface

attribute perimeta::service_interface::ipv4_per_instance_address_per_instance_address_t per_instance_address

Per-instance address name

relation perimeta::service_interface::Ipv4Identity ipv4 [1]

other end: perimeta::service_interface::Ipv4Identity.per_instance_address [0:*]

The following implementations are defined for this entity:

• perimeta::service_interface::ipv4_per_instance_address_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv4_per_instance_address_uri constraint true

entity perimeta::service_interface::Ipv4PerInstanceAddressUnmanaged

Parents: perimeta::service_interface::Ipv4PerInstanceAddressIdentity

Unmanaged reference to a /service-interface/ipv4/per-instance-address Perimeta API resource.

Sets a per-instance IPv4 address for this service interface

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::Ipv4Unmanaged

Parents: perimeta::service_interface::Ipv4Identity

Unmanaged reference to a /service-interface/ipv4 Perimeta API resource.

Configuration mode for an IPv4 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::Ipv6

Parents: perimeta::service_interface::Ipv6Identity, std::PurgeableResource

Inmanta resource to manage a /service-interface/ipv6 Perimeta API resource.

Configuration mode for an IPv6 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? activate=null

Activates the IPv6 subnet configuration.

attribute std::ipv6_address gateway_ip_address

Sets the IP address of a default gateway in your network.

attribute perimeta::service_interface::ipv6_gateway_static_mac_address_t? gateway_static_mac_address=null

Provide the static MAC address of the gateway

attribute perimeta::service_interface::ipv6_gateway_static_mac_address_value_t? gateway_static_mac_address_value=null

Set the static MAC address of the gateway IP address. This is only required if the provided gateway does not respond to NDP probes.

attribute perimeta::service_interface::ipv6_subnet_prefix_length_t subnet_prefix_length

Sets the subnet prefix length of the local subnet.

attribute std::ipv6_address? probes_target=null

Sets the target IP address for NDP probing. For example, you can use the IP address of a softswitch in your core service network or a default gateway in your access service network. You must make sure that the address you configure has a low latency from your Session Controller, because a reliable response time of less than 50ms is expected.

attribute perimeta::service_interface::ipv6_probes_source_style_t? probes_source_style=null

Sets the probing source type you want to use for IPv6 NDP probing. For the specific-source type, you must set source IP addresses: - On a high availability system, set four IP addresses. - On a standalone system, set two IP addresses.

attribute std::ipv6_address? probes_source_ip_shelf_A_interface_1=null

The first source address to use on instance A for NDP probes.

attribute std::ipv6_address? probes_source_ip_shelf_A_interface_2=null

The second source address to use on instance A for NDP probes.

attribute std::ipv6_address? probes_source_ip_shelf_B_interface_1=null

The first source address to use on instance B for NDP probes.

attribute std::ipv6_address? probes_source_ip_shelf_B_interface_2=null

The second source address to use on instance B for NDP probes.

attribute std::ipv6_address? probes_source_ip_interface_1=null

The first source address to use on a standalone system for NDP probes.

attribute std::ipv6_address? probes_source_ip_interface_2=null

The second source address to use on a standalone system for NDP probes.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::service_interface::ipv6_config

• perimeta::service_interface::ipv6_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv6_config, perimeta::service_interface::ipv6_cross_device_relations constraint true

entity perimeta::service_interface::Ipv6Identity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface/ipv6 Perimeta API resource. Abstract base entity. For concrete usage, see children Ipv6 and Ipv6Unmanaged.

Configuration mode for an IPv6 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

relation perimeta::service_interface::ServiceInterfaceIdentity service_interface [1]

other end: perimeta::service_interface::ServiceInterfaceIdentity.ipv6 [0:1]

relation perimeta::service_interface::Ipv6LocalIpAddressIdentity local_ip_address [0:*]

other end: perimeta::service_interface::Ipv6LocalIpAddressIdentity.ipv6 [1]

The following implementations are defined for this entity:

• perimeta::service_interface::ipv6_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv6_uri constraint true

entity perimeta::service_interface::Ipv6LocalIpAddress

Parents: perimeta::service_interface::Ipv6LocalIpAddressIdentity, std::PurgeableResource

Inmanta resource to manage a /service-interface/ipv6/local-ip-address Perimeta API resource.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::service_interface::ipv6_local_ip_address_local_ip_address_usage_t? local_ip_address_usage=null

Set whether or not this IP address is an (off-LAN) IP address outside of the subnet.

attribute perimeta::service_interface::ipv6_local_ip_address_service_address_t? service_address=null

Assigns a service address name to this IP address on this service interface. You will use this name to select the address when configuring adjacencies and other configuration objects.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::service_interface::ipv6_local_ip_address_config

• perimeta::service_interface::ipv6_local_ip_address_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv6_local_ip_address_config, perimeta::service_interface::ipv6_local_ip_address_cross_device_relations constraint true

entity perimeta::service_interface::Ipv6LocalIpAddressIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface/ipv6/local-ip-address Perimeta API resource. Abstract base entity. For concrete usage, see children Ipv6LocalIpAddress and Ipv6LocalIpAddressUnmanaged.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

attribute std::ipv6_address local_ip_address

Sets the local IPv6 address of the service interface.

relation perimeta::service_interface::Ipv6Identity ipv6 [1]

other end: perimeta::service_interface::Ipv6Identity.local_ip_address [0:*]

The following implementations are defined for this entity:

• perimeta::service_interface::ipv6_local_ip_address_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::ipv6_local_ip_address_uri constraint true

entity perimeta::service_interface::Ipv6LocalIpAddressUnmanaged

Parents: perimeta::service_interface::Ipv6LocalIpAddressIdentity

Unmanaged reference to a /service-interface/ipv6/local-ip-address Perimeta API resource.

Sets a local subnet IP address or an off-LAN IP address for the service interface. You can configure more than one local IP address on each service interface.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::Ipv6Unmanaged

Parents: perimeta::service_interface::Ipv6Identity

Unmanaged reference to a /service-interface/ipv6 Perimeta API resource.

Configuration mode for an IPv6 subnet for a service interface on the Session Controller. The commands in this mode allow you to specify the subnet prefix length and default gateway that will be used by the service interface.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::service_interface::ServiceInterface

Parents: perimeta::service_interface::ServiceInterfaceIdentity, std::PurgeableResource

Inmanta resource to manage a /service-interface Perimeta API resource.

Creates and names a service interface, or selects the named service interface if it already exists. A service interface is a configuration object that represents how the Session Controller connects to a corresponding service network. The name of the service interface should be of the form servID, where ID is a unique identifier you want to use for the service interface and is a positive integer.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::service_interface::service_interface_dns_dscp_settings_t? dns_dscp_settings=null

Specifies the DSCP settings to be used on DNS queries made over this service interface. The default is 0. Permissible values are all integers between 0 and 63, inclusive.

attribute perimeta::service_interface::service_interface_description_t? description=null

Sets a useful description for the service interface.

attribute perimeta::service_interface::service_interface_network_security_t network_security

Sets whether the service interface is trusted, restricted, untrusted or untrusted-priority. This determines which kinds of traffic are admitted on the interface and how packets arriving over the interface are prioritised when the system is under load. For full details, see Security and trust in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/SecurityAndTrust.html).

attribute perimeta::service_interface::service_interface_service_network_t service_network

Specifies the ID of the service network used by this service interface. This must match the integer used in the service-interface Index.

attribute perimeta::service_interface::service_interface_port_group_name_t? port_group_name=null

Sets the redundant port group the Session Controller uses to connect to the service interface. You can retrieve a list of available port groups by sending a GET request on the port-group-names Property.

attribute perimeta::service_interface::service_interface_vlan_id_t? vlan_id=null

Sets the VLAN tag that the Session Controller uses for packets received on this service interface. How the Session Controller uses VLAN tags depends on the kind of service interface. - For regular core and access service interfaces, the Session Controller uses VLAN tags to distinguish traffic on the service interface from other traffic on the same port group. VLAN tags are required if you have more than one service interface; each service interface associated with a given port group must have a unique VLAN tag. The VLAN tag must match the VLAN configuration on your Ethernet switches. To use VLAN tags with regular service interfaces, your NICs must support VLAN tagging. If your NICs do not support VLAN tagging, the Session Controller warns you about any service interfaces that are configured with a VLAN tag and does not activate these service interfaces. For more information on VLAN support, see VLAN support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/VLANTags.html). Perimeta guests cannot set VLAN tags on packets going through regular core and access service interfaces in the following circumstances. - Perimeta is deployed in any virtualized environment using SR-IOV (referred to as accelerated networking on Azure) where the NIC drivers do not support guest VLAN tagging. - Perimeta is deployed in an OpenStack environment using virtio network interfaces and VLAN support has not been enabled via the orchestration API. - For overlay service interfaces (only available in Azure deployments), the Session Controller uses VLAN tags to distinguish traffic on the overlay service interface from other traffic received via the same VXLAN tunnel. Therefore, if you configure an overlay service interface with a VXLAN tunnel, you must also configure that service interface with a unique VLAN tag. You create VXLAN tunnels using the tunnel vxlan command, and configure tunnels on a service interface using the transport-tunnel command. For more information on VXLANs, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

attribute perimeta::service_interface::service_interface_mtu_t? mtu=null

Determines whether this service interface will use a specific Maximum Transmission Unit (MTU) value (specified using the mtu-value Property) or inherit its MTU value from the port group or the transport tunnel’s service interface.

attribute perimeta::service_interface::service_interface_mtu_value_t? mtu_value=null

Specifies the Maximum Transmission Unit (MTU) that this service interface will use (in bytes).

attribute perimeta::service_interface::service_interface_probes_type_t? probes_type=null

Specifies whether the service interface uses IPv4 ARP probes or IPv6 NDP probes, or no probing. The default is IPv4 (ARP).

attribute perimeta::service_interface::service_interface_criticality_t? criticality=null

Sets how critical the service interface is to your deployment. The Session Controller uses this value in determining whether to do a software protection switch (SPS) if Ethernet connectivity is lost. This is a value between 0 and 1000, where 0 is non-critical and 1000 is the highest possible criticality. Typically, you should set this to 0 for a low-priority service interface or to 10 for a high-priority service interface. If you think you need to set this to something else for your deployment, talk to your Metaswitch customer support engineer.

attribute perimeta::service_interface::service_interface_probes_interval_t? probes_interval=null

Sets the interval (in milliseconds) between each probe. The default value works for most deployments. If you want to change this value, talk to your Metaswitch customer support engineer.

attribute perimeta::service_interface::service_interface_probes_failure_threshold_t? probes_failure_threshold=null

Sets the number of probing failures required for the Session Controller to raise an alarm. The default value works for most deployments. If you want to change this value, talk to your Metaswitch customer support engineer.

attribute perimeta::service_interface::service_interface_probes_success_threshold_t? probes_success_threshold=null

Sets the number of probing successes required for the Session Controller to consider a service-interface as online. The default value works for most deployments. If you want to change this value, talk to your Metaswitch customer support engineer.

attribute perimeta::service_interface::service_interface_dns_servers_t? dns_servers=null

Specifies a space-separated list of one or more DNS servers in the service network to which this service interface corresponds. You can specify IP addresses for up to 16 DNS servers, but the service interface will only query the first 4. If a service interface needs to be able to query more than 4 separate DNS servers, you must configure it to use the management network’s DNS servers. If you are planning to use the hunt selection mode, you should enter the DNS servers in order of priority, beginning with the highest. The Session Controller can use these DNS servers for all DNS queries sent from this service interface, which can include: - Requests from adjacencies and Rf peers configured on this service interface that inherit the DNS settings of this service interface. Inheriting the service interface configuration is the default behavior for adjacencies and Rf peers. - Requests from an adjacency or Rf peer on any service interface that is explicitly configured to send DNS queries from a service address on this service interface. - Requests to a signing or verification server that the Session Controller contacts from a service address on this service interfaces. The Session Controller identifies DNS servers configured on a service interface as unrestricted sources and they are not subject to rate limiting or blocklisting. If you are planning to configure DNS servers on an untrusted service interface, you must ensure that this service interface connects to a network that is protected against IP spoofing (for example, through network ingress filtering methods such as an access control list configured on the router). For more information, see DNS support in Perimeta Network Integration Guide (https://manuals.metaswitch.com/Perimeta/latest/NetworkIntegrationGuide/Source/Perimeta/Concepts/DNSSupport.html)

attribute perimeta::service_interface::service_interface_dns_selection_mode_t? dns_selection_mode=null

Specifies the method by which the Session Controller should select a DNS server for a particular DNS query. This command only applies if you have configured the Session Controller to contact more than one DNS server in the service network to which this service interface corresponds. For more information, see DNS support in Perimeta Network Integration Guide (https://manuals.metaswitch.com/Perimeta/latest/NetworkIntegrationGuide/Source/Perimeta/Concepts/DNSSupport.html)

attribute perimeta::service_interface::service_interface_dns_source_t? dns_source=null

Specifies the source address to use for DNS queries for requests made over this service interface. Choose from the following. - Sending DNS queries over the management network to DNS severs in that network. This is the default. - Sending queries over a service network (either the one to which the service interface connects or a different one). To do this, specify a service address as the source of queries. If you do this: - The Session Controller will send requests from this address to the DNS servers configured on the service interface on which the service address is configured. - If the service interface has more than one DNS server, the Session Controller also uses its DNS server selection method configured with the dns-selection-mode command to choose between them. - Using Perimeta’s legacy behavior (not recommended). If this service interface is configured with at least one DNS server (using the dns-servers command), the Session Controller sends requests from an unspecified address on this service interface. Otherwise, the Session Controller uses the DNS servers in the management network. For more information, see DNS support in Perimeta Network Integration Guide (https://manuals.metaswitch.com/Perimeta/latest/NetworkIntegrationGuide/Source/Perimeta/Concepts/DNSSupport.html)

attribute perimeta::service_interface::service_interface_dns_source_service_address_t? dns_source_service_address=null

Specifies the service address to use as the source of DNS queries for requests on this service interface

attribute bool? enable_icmp_responses=null

Specifies whether the Session Controller must allow incoming ICMP echo requests received on the service interface. Disabling this setting will cause the Session Controller to block ICMP echo requests, prevents any risk of attackers using ICMP echo requests as a probing mechanism to look for vulnerabilities. We recommend that you block incoming ICMP echo requests unless there is a direct requirement for the Session Controller to send ICMP responses from this service interface in your network. This command applies only to restricted, untrusted, and untrusted-priority service interfaces. The Session Controller will always send ICMP responses to ICMP echo requests received from an unrestricted source, even if ICMP echo requests are blocked on the service interface on which the requests were received.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel transport_tunnel: Configure a transport tunnel for this service interface :rel off_lan_recv_from_tunnel: Configure a tunnel from which this service interface can receive traffic that’s sent to an off-LAN local address

relation perimeta::tunnel::TunnelIdentity transport_tunnel [0:1]

Configure a transport tunnel for this service interface Peer relation:

relation perimeta::inbound_tunnel::InboundTunnelIdentity off_lan_recv_from_tunnel [0:1]

Configure a tunnel from which this service interface can receive traffic that’s sent to an off-LAN local address Peer relation:

The following implementations are defined for this entity:

• perimeta::service_interface::service_interface_config

• perimeta::service_interface::service_interface_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::service_interface::service_interface_config, perimeta::service_interface::service_interface_cross_device_relations constraint true

entity perimeta::service_interface::ServiceInterfaceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /service-interface Perimeta API resource. Abstract base entity. For concrete usage, see children ServiceInterface and ServiceInterfaceUnmanaged.

Creates and names a service interface, or selects the named service interface if it already exists. A service interface is a configuration object that represents how the Session Controller connects to a corresponding service network. The name of the service interface should be of the form servID, where ID is a unique identifier you want to use for the service interface and is a positive integer.

attribute perimeta::service_interface::service_interface_service_interface_t service_interface

Specifies a name for the service interface. The name of the service interface should be of the form servID, where ID is a unique identifier you want to use for the service interface and is a positive integer.

relation perimeta::service_interface::Ipv4Identity ipv4 [0:1]

other end: perimeta::service_interface::Ipv4Identity.service_interface [1]

relation perimeta::service_interface::Ipv6Identity ipv6 [0:1]

other end: perimeta::service_interface::Ipv6Identity.service_interface [1]

The following implementations are defined for this entity:

• perimeta::service_interface::service_interface_uri

The following implements statements select implementations for this entity:

• perimeta::service_interface::service_interface_uri constraint true

entity perimeta::service_interface::ServiceInterfaceUnmanaged

Parents: perimeta::service_interface::ServiceInterfaceIdentity

Unmanaged reference to a /service-interface Perimeta API resource.

Creates and names a service interface, or selects the named service interface if it already exists. A service interface is a configuration object that represents how the Session Controller connects to a corresponding service network. The name of the service interface should be of the form servID, where ID is a unique identifier you want to use for the service interface and is a positive integer.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::signaling::Signaling

Parents: perimeta::signaling::SignalingIdentity, std::PurgeableResource

Inmanta resource to manage a /signaling Perimeta API resource.

This Resource contains global signaling properties.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::signaling::signaling_sip_3xx_embedded_header_pass_mode_t? sip_3xx_embedded_header_pass_mode=null

The passthrough mode for headers embedded in a 3XX contact header.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::signaling::signaling_config

• perimeta::signaling::signaling_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::signaling::signaling_config, perimeta::signaling::signaling_cross_device_relations constraint true

entity perimeta::signaling::SignalingIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /signaling Perimeta API resource. Abstract base entity. For concrete usage, see children Signaling and SignalingUnmanaged.

This Resource contains global signaling properties.

The following implementations are defined for this entity:

• perimeta::signaling::signaling_uri

The following implements statements select implementations for this entity:

• perimeta::signaling::signaling_uri constraint true

entity perimeta::signaling::SignalingUnmanaged

Parents: perimeta::signaling::SignalingIdentity

Unmanaged reference to a /signaling Perimeta API resource.

This Resource contains global signaling properties.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_generic_stream_list::SipGenericStreamList

Parents: perimeta::sip_generic_stream_list::SipGenericStreamListIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-generic-stream-list Perimeta API resource.

Resource for a generic stream list. Generic streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using the call media policy to which the list is applied.

You must use the Perimeta CLI to configure the generic streams within generic stream lists. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html) and Configuring a generic stream list in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ConfiguringAGenericStreamList.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_generic_stream_list::sip_generic_stream_list_config

• perimeta::sip_generic_stream_list::sip_generic_stream_list_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_generic_stream_list::sip_generic_stream_list_config, perimeta::sip_generic_stream_list::sip_generic_stream_list_cross_device_relations constraint true

entity perimeta::sip_generic_stream_list::SipGenericStreamListIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-generic-stream-list Perimeta API resource. Abstract base entity. For concrete usage, see children SipGenericStreamList and SipGenericStreamListUnmanaged.

Resource for a generic stream list. Generic streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using the call media policy to which the list is applied.

You must use the Perimeta CLI to configure the generic streams within generic stream lists. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html) and Configuring a generic stream list in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ConfiguringAGenericStreamList.html).

attribute perimeta::sip_generic_stream_list::sip_generic_stream_list_sip_generic_stream_list_name_t sip_generic_stream_list_name

Name of generic stream list

The following implementations are defined for this entity:

• perimeta::sip_generic_stream_list::sip_generic_stream_list_uri

The following implements statements select implementations for this entity:

• perimeta::sip_generic_stream_list::sip_generic_stream_list_uri constraint true

entity perimeta::sip_generic_stream_list::SipGenericStreamListUnmanaged

Parents: perimeta::sip_generic_stream_list::SipGenericStreamListIdentity

Unmanaged reference to a /sip-generic-stream-list Perimeta API resource.

Resource for a generic stream list. Generic streams are media streams in which the media description contains a * instead of a codec list. A generic stream list specifies the generic streams that the Session Controller must passthrough when sent or received on an adjacency, account or traffic group using the call media policy to which the list is applied.

You must use the Perimeta CLI to configure the generic streams within generic stream lists. For more information, see Generic streams in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/GenericStreams.html) and Configuring a generic stream list in Perimeta Configuration and Interoperabililty Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/ConfiguringAGenericStreamList.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfile

Parents: perimeta::sip_message_manipulation::BodyManipulationProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/body-manipulation-profile Perimeta API resource.

This resource represents a body profile in the SIP Message Manipulation Framework. Body profiles apply to a particular message body type and can be used to strip or pass through the message body, or reject the message altogether. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::body_manipulation_profile_description_t? description=null

Sets a description of up to 64 characters for the profile.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_config

• perimeta::sip_message_manipulation::body_manipulation_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_config, perimeta::sip_message_manipulation::body_manipulation_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/body-manipulation-profile Perimeta API resource. Abstract base entity. For concrete usage, see children BodyManipulationProfile and BodyManipulationProfileUnmanaged.

This resource represents a body profile in the SIP Message Manipulation Framework. Body profiles apply to a particular message body type and can be used to strip or pass through the message body, or reject the message altogether. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

attribute perimeta::sip_message_manipulation::body_manipulation_profile_profile_name_t profile_name

Specifies the name of the body profile.

relation perimeta::sip_message_manipulation::BodyManipulationProfileRuleIdentity rule [0:*]

other end: perimeta::sip_message_manipulation::BodyManipulationProfileRuleIdentity.body_manipulation_profile [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_uri constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfileRule

Parents: perimeta::sip_message_manipulation::BodyManipulationProfileRuleIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/body-manipulation-profile/rule Perimeta API resource.

Creates and names a rule in the body profile. You can set the body type that the rule manipulates and the action that the Session Controller must take. You can also configure the Session Controller to apply a replacement profile or trigger hunting. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::body_manipulation_profile_rule_action_t? action=null

Set the action that this rule applies to the specified body type. The default action is to pass through the message.

attribute bool? hunt_on_reject=null

Sets this rule to trigger hunting (searching for an alternative destination adjacency for the message) if it rejects the message.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel apply_replacement_profile: The replacement profile to apply to messages with this body type. Note that replacement profiles can only be created and edited using the Perimeta command line interface (CLI).

relation perimeta::sip_message_manipulation::ReplacementProfileIdentity apply_replacement_profile [0:1]

The replacement profile to apply to messages with this body type. Note that replacement profiles can only be created and

edited using the Perimeta command line interface (CLI).

Peer relation:

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_rule_config

• perimeta::sip_message_manipulation::body_manipulation_profile_rule_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_rule_config, perimeta::sip_message_manipulation::body_manipulation_profile_rule_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfileRuleIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/body-manipulation-profile/rule Perimeta API resource. Abstract base entity. For concrete usage, see children BodyManipulationProfileRule and BodyManipulationProfileRuleUnmanaged.

Creates and names a rule in the body profile. You can set the body type that the rule manipulates and the action that the Session Controller must take. You can also configure the Session Controller to apply a replacement profile or trigger hunting. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

attribute perimeta::sip_message_manipulation::body_manipulation_profile_rule_content_type_t content_type

The SIP body Content-Type to which this rule will apply.

relation perimeta::sip_message_manipulation::BodyManipulationProfileIdentity body_manipulation_profile [1]

other end: perimeta::sip_message_manipulation::BodyManipulationProfileIdentity.rule [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_rule_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::body_manipulation_profile_rule_uri constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfileRuleUnmanaged

Parents: perimeta::sip_message_manipulation::BodyManipulationProfileRuleIdentity

Unmanaged reference to a /sip-message-manipulation/body-manipulation-profile/rule Perimeta API resource.

Creates and names a rule in the body profile. You can set the body type that the rule manipulates and the action that the Session Controller must take. You can also configure the Session Controller to apply a replacement profile or trigger hunting. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::BodyManipulationProfileUnmanaged

Parents: perimeta::sip_message_manipulation::BodyManipulationProfileIdentity

Unmanaged reference to a /sip-message-manipulation/body-manipulation-profile Perimeta API resource.

This resource represents a body profile in the SIP Message Manipulation Framework. Body profiles apply to a particular message body type and can be used to strip or pass through the message body, or reject the message altogether. For more information, see Configuring SIP body profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPBodyProfiles.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::ErrorProfile

Parents: perimeta::sip_message_manipulation::ErrorProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/error-profile Perimeta API resource.

Configuration mode for a SIP error profile. An error profile defines a set of mappings between internal Session Controller errors and SIP response codes (and optionally reason text). For more information, see Configuring SIP error profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPErrorProfiles.html). For a list of internal error causes, see Default SIP error code mappings in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/DefaultSIPErrorCodeMappings.html).

Note: the following external error codes correspond to the given internal error causes. When the Session Controller receives one of these error codes, it carries out the mapping for the corresponding internal error cause and generates a new SIP response code.

• 404 - Call rejected during routing

• 410 - Call rejected during routing

• 484 - Call rejected by number analysis

• 485 - Call rejected during routing

• 604 - Call rejected during routing

For example, if the Session Controller receives a 404 error and you have configured this profile to map “Call rejected during routing” to the 503 error code, the Session Controller will generate a 503 error code.

Note: If you do not already use error profiles, Metaswitch recommends that you use SIP header profiles instead. Header profiles are more powerful and flexible than error profiles.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? override_rtp_not_allowed_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_code_t? override_rtp_not_allowed_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_reason_t? override_rtp_not_allowed_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_per_call_scope_code_t? override_rtp_not_allowed_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_per_call_scope_reason_t? override_rtp_not_allowed_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_calling_number_scope_code_t? override_rtp_not_allowed_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_calling_number_scope_reason_t? override_rtp_not_allowed_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_IP_scope_code_t? override_rtp_not_allowed_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_IP_scope_reason_t? override_rtp_not_allowed_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_destination_scope_code_t? override_rtp_not_allowed_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_destination_scope_reason_t? override_rtp_not_allowed_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_scope_code_t? override_rtp_not_allowed_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_source_scope_reason_t? override_rtp_not_allowed_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_rtp_not_allowed_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where RTP is not allowed at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_other_scope_code_t? override_rtp_not_allowed_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_rtp_not_allowed_other_scope_reason_t? override_rtp_not_allowed_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_code_t? override_srtp_not_allowed_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_reason_t? override_srtp_not_allowed_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_per_call_scope_code_t? override_srtp_not_allowed_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_per_call_scope_reason_t? override_srtp_not_allowed_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_calling_number_scope_code_t? override_srtp_not_allowed_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_calling_number_scope_reason_t? override_srtp_not_allowed_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_IP_scope_code_t? override_srtp_not_allowed_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_IP_scope_reason_t? override_srtp_not_allowed_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_destination_scope_code_t? override_srtp_not_allowed_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_destination_scope_reason_t? override_srtp_not_allowed_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_scope_code_t? override_srtp_not_allowed_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_source_scope_reason_t? override_srtp_not_allowed_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_not_allowed_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where SRTP is not allowed at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_other_scope_code_t? override_srtp_not_allowed_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_not_allowed_other_scope_reason_t? override_srtp_not_allowed_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_msrp_not_allowed_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where MSRP is not allowed.

attribute perimeta::sip_message_manipulation::error_profile_override_msrp_not_allowed_code_t? override_msrp_not_allowed_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_msrp_not_allowed_reason_t? override_msrp_not_allowed_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_msrps_not_allowed_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections where MSRPS is not allowed.

attribute perimeta::sip_message_manipulation::error_profile_override_msrps_not_allowed_code_t? override_msrps_not_allowed_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_msrps_not_allowed_reason_t? override_msrps_not_allowed_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_srtp_general_error_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a general SRTP error.

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_general_error_code_t? override_srtp_general_error_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_override_srtp_general_error_reason_t? override_srtp_general_error_reason=null

Reason header value in format specified by RFC 3326. For example “SIP;cause=500;reason=\”Example text\””

attribute bool? override_too_many_media_streams_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent media streams being breached.

attribute perimeta::sip_message_manipulation::error_profile_override_too_many_media_streams_code_t? override_too_many_media_streams_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_too_many_media_streams_reason_t? override_too_many_media_streams_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_acceptable_codec_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections when no acceptable codec is available.

attribute perimeta::sip_message_manipulation::error_profile_override_no_acceptable_codec_code_t? override_no_acceptable_codec_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_override_no_acceptable_codec_reason_t? override_no_acceptable_codec_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_config

• perimeta::sip_message_manipulation::error_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_config, perimeta::sip_message_manipulation::error_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponses

Parents: perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/error-profile/call-policy-set-error-responses Perimeta API resource.

The call-policy-set-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to call policy set errors on the adjacency to which the parent error-profile Resource is applied.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? override_max_routing_routes_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to the maximum number of routing attempts being exceeded.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_max_routing_routes_code_t? override_max_routing_routes_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_max_routing_routes_reason_t? override_max_routing_routes_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections during routing.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_code_t? override_no_route_found_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_reason_t? override_no_route_found_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_source_address_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source ID routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_address_code_t? override_no_route_found_bad_source_address_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_address_reason_t? override_no_route_found_bad_source_address_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_destination_address_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a destination ID routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_address_code_t? override_no_route_found_bad_destination_address_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_address_reason_t? override_no_route_found_bad_destination_address_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_source_adjacency_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source adjacency routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_adjacency_code_t? override_no_route_found_bad_source_adjacency_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_adjacency_reason_t? override_no_route_found_bad_source_adjacency_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_source_account_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source account routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_account_code_t? override_no_route_found_bad_source_account_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_account_reason_t? override_no_route_found_bad_source_account_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_category_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a category routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_category_code_t? override_no_route_found_bad_category_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_category_reason_t? override_no_route_found_bad_category_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_source_domain_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source domain routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_domain_code_t? override_no_route_found_bad_source_domain_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_domain_reason_t? override_no_route_found_bad_source_domain_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_destination_domain_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a destination domain routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_domain_code_t? override_no_route_found_bad_destination_domain_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_domain_reason_t? override_no_route_found_bad_destination_domain_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_time_table_rejection_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a time routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_time_table_rejection_code_t? override_no_route_found_time_table_rejection_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_time_table_rejection_reason_t? override_no_route_found_time_table_rejection_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_destination_tgid_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a destination trunk group ID routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_tgid_code_t? override_no_route_found_bad_destination_tgid_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_destination_tgid_reason_t? override_no_route_found_bad_destination_tgid_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_source_tgid_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source trunk group ID routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_tgid_code_t? override_no_route_found_bad_source_tgid_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_source_tgid_reason_t? override_no_route_found_bad_source_tgid_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_bad_carrier_id_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a carrier identification code routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_carrier_id_code_t? override_no_route_found_bad_carrier_id_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_bad_carrier_id_reason_t? override_no_route_found_bad_carrier_id_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_round_robin_rejection_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a round robin routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_round_robin_rejection_code_t? override_no_route_found_round_robin_rejection_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_round_robin_rejection_reason_t? override_no_route_found_round_robin_rejection_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_no_route_found_least_cost_rejection_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a least cost routing table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_least_cost_rejection_code_t? override_no_route_found_least_cost_rejection_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_no_route_found_least_cost_rejection_reason_t? override_no_route_found_least_cost_rejection_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_route_unavailable_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use when responding to SIP requests rejected due to being routed to an unavailable adjacency.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_route_unavailable_code_t? override_route_unavailable_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_route_unavailable_reason_t? override_route_unavailable_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use when responding to SIP requests rejected by number analysis.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_code_t? override_invalid_address_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_reason_t? override_invalid_address_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_destination_id_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a destination ID number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_destination_id_code_t? override_invalid_address_bad_destination_id_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_destination_id_reason_t? override_invalid_address_bad_destination_id_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_source_adjacency_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source adjacency number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_adjacency_code_t? override_invalid_address_bad_source_adjacency_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_adjacency_reason_t? override_invalid_address_bad_source_adjacency_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_source_account_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source account number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_account_code_t? override_invalid_address_bad_source_account_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_account_reason_t? override_invalid_address_bad_source_account_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_subscriber_category_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a subscriber category number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_subscriber_category_code_t? override_invalid_address_bad_subscriber_category_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_subscriber_category_reason_t? override_invalid_address_bad_subscriber_category_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_carrier_id_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a carrier identification code number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_carrier_id_code_t? override_invalid_address_bad_carrier_id_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_carrier_id_reason_t? override_invalid_address_bad_carrier_id_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_bad_source_id_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected by a source ID number analysis table.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_id_code_t? override_invalid_address_bad_source_id_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_bad_source_id_reason_t? override_invalid_address_bad_source_id_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_invalid_address_no_calling_number_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected due to a lack of source ID.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_no_calling_number_code_t? override_invalid_address_no_calling_number_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_invalid_address_no_calling_number_reason_t? override_invalid_address_no_calling_number_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_enum_failure_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use when responding to SIP requests rejected due to an ENUM lookup failure.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_code_t? override_enum_failure_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_reason_t? override_enum_failure_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_enum_failure_enum_not_found_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected due to an ENUM response returning a ‘not found’ error.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_not_found_code_t? override_enum_failure_enum_not_found_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_not_found_reason_t? override_enum_failure_enum_not_found_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_enum_failure_enum_void_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use when responding to SIP requests rejected due to an ENUM lookup returning a ‘E2U+VOID’ response.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_void_code_t? override_enum_failure_enum_void_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_override_enum_failure_enum_void_reason_t? override_enum_failure_enum_void_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_config

• perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_config, perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/error-profile/call-policy-set-error-responses Perimeta API resource. Abstract base entity. For concrete usage, see children ErrorProfileCallPolicySetErrorResponses and ErrorProfileCallPolicySetErrorResponsesUnmanaged.

The call-policy-set-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to call policy set errors on the adjacency to which the parent error-profile Resource is applied.

relation perimeta::sip_message_manipulation::ErrorProfileIdentity error_profile [1]

other end: perimeta::sip_message_manipulation::ErrorProfileIdentity.call_policy_set_error_responses [0:1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_uri constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesUnmanaged

Parents: perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesIdentity

Unmanaged reference to a /sip-message-manipulation/error-profile/call-policy-set-error-responses Perimeta API resource.

The call-policy-set-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to call policy set errors on the adjacency to which the parent error-profile Resource is applied.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponses

Parents: perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/error-profile/capacity-control-error-responses Perimeta API resource.

The capacity-control-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to a breach of capacity control limits on the adjacency to which the parent error-profile Resource is applied.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? override_breached_call_rate_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_code_t? override_breached_call_rate_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_reason_t? override_breached_call_rate_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_per_call_scope_code_t? override_breached_call_rate_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_per_call_scope_reason_t? override_breached_call_rate_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_calling_number_scope_code_t? override_breached_call_rate_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_calling_number_scope_reason_t? override_breached_call_rate_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_IP_scope_code_t? override_breached_call_rate_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_IP_scope_reason_t? override_breached_call_rate_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_destination_scope_code_t? override_breached_call_rate_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_destination_scope_reason_t? override_breached_call_rate_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_scope_code_t? override_breached_call_rate_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_source_scope_reason_t? override_breached_call_rate_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_call_rate_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on call setup rate being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_other_scope_code_t? override_breached_call_rate_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_call_rate_other_scope_reason_t? override_breached_call_rate_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_code_t? override_breached_concurrent_calls_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_reason_t? override_breached_concurrent_calls_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_per_call_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_per_call_scope_code_t? override_breached_concurrent_calls_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_per_call_scope_reason_t? override_breached_concurrent_calls_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_calling_number_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_calling_number_scope_code_t? override_breached_concurrent_calls_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_calling_number_scope_reason_t? override_breached_concurrent_calls_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_source_IP_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_IP_scope_code_t? override_breached_concurrent_calls_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_IP_scope_reason_t? override_breached_concurrent_calls_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_destination_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_destination_scope_code_t? override_breached_concurrent_calls_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_destination_scope_reason_t? override_breached_concurrent_calls_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_source_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_scope_code_t? override_breached_concurrent_calls_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_source_scope_reason_t? override_breached_concurrent_calls_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_concurrent_calls_other_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent calls being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_other_scope_code_t? override_breached_concurrent_calls_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_concurrent_calls_other_scope_reason_t? override_breached_concurrent_calls_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_code_t? override_breached_in_call_message_rate_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_reason_t? override_breached_in_call_message_rate_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_per_call_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_per_call_scope_code_t? override_breached_in_call_message_rate_per_call_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_per_call_scope_reason_t? override_breached_in_call_message_rate_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_calling_number_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_calling_number_scope_code_t? override_breached_in_call_message_rate_calling_number_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_calling_number_scope_reason_t? override_breached_in_call_message_rate_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_source_IP_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_IP_scope_code_t? override_breached_in_call_message_rate_source_IP_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_IP_scope_reason_t? override_breached_in_call_message_rate_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_destination_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_destination_scope_code_t? override_breached_in_call_message_rate_destination_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_destination_scope_reason_t? override_breached_in_call_message_rate_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_source_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_scope_code_t? override_breached_in_call_message_rate_source_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_source_scope_reason_t? override_breached_in_call_message_rate_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_in_call_message_rate_other_scope_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on in-call signaling message rate being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_other_scope_code_t? override_breached_in_call_message_rate_other_scope_code=null

SIP status code

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_in_call_message_rate_other_scope_reason_t? override_breached_in_call_message_rate_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on out-of-call signaling message rate being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_code_t? override_breached_out_of_call_message_rate_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_reason_t? override_breached_out_of_call_message_rate_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_per_call_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_per_call_scope_code_t? override_breached_out_of_call_message_rate_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_per_call_scope_reason_t? override_breached_out_of_call_message_rate_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_calling_number_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_calling_number_scope_code_t? override_breached_out_of_call_message_rate_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_calling_number_scope_reason_t? override_breached_out_of_call_message_rate_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_source_IP_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_IP_scope_code_t? override_breached_out_of_call_message_rate_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_IP_scope_reason_t? override_breached_out_of_call_message_rate_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_destination_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_destination_scope_code_t? override_breached_out_of_call_message_rate_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_destination_scope_reason_t? override_breached_out_of_call_message_rate_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_source_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_scope_code_t? override_breached_out_of_call_message_rate_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_source_scope_reason_t? override_breached_out_of_call_message_rate_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_out_of_call_message_rate_other_scope_response=null

Specifies the SIP error code the Session Controller must generate when rejecting a SIP request due to a capacity control limit on out-of-call signaling message rate being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_other_scope_code_t? override_breached_out_of_call_message_rate_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_out_of_call_message_rate_other_scope_reason_t? override_breached_out_of_call_message_rate_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_code_t? override_breached_regs_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_reason_t? override_breached_regs_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_per_call_scope_code_t? override_breached_regs_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_per_call_scope_reason_t? override_breached_regs_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_calling_number_scope_code_t? override_breached_regs_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_calling_number_scope_reason_t? override_breached_regs_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_IP_scope_code_t? override_breached_regs_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_IP_scope_reason_t? override_breached_regs_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_destination_scope_code_t? override_breached_regs_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_destination_scope_reason_t? override_breached_regs_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_scope_code_t? override_breached_regs_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_source_scope_reason_t? override_breached_regs_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent registrations being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_other_scope_code_t? override_breached_regs_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_other_scope_reason_t? override_breached_regs_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_code_t? override_breached_regs_rate_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_reason_t? override_breached_regs_rate_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_per_call_scope_code_t? override_breached_regs_rate_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_per_call_scope_reason_t? override_breached_regs_rate_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_calling_number_scope_code_t? override_breached_regs_rate_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_calling_number_scope_reason_t? override_breached_regs_rate_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_IP_scope_code_t? override_breached_regs_rate_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_IP_scope_reason_t? override_breached_regs_rate_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_destination_scope_code_t? override_breached_regs_rate_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_destination_scope_reason_t? override_breached_regs_rate_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_scope_code_t? override_breached_regs_rate_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_source_scope_reason_t? override_breached_regs_rate_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_regs_rate_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on registration rate being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_other_scope_code_t? override_breached_regs_rate_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_regs_rate_other_scope_reason_t? override_breached_regs_rate_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on concurrent media streams being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_code_t? override_breached_media_streams_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_reason_t? override_breached_media_streams_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_per_call_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_per_call_scope_code_t? override_breached_media_streams_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_per_call_scope_reason_t? override_breached_media_streams_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_calling_number_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_calling_number_scope_code_t? override_breached_media_streams_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_calling_number_scope_reason_t? override_breached_media_streams_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_source_IP_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_IP_scope_code_t? override_breached_media_streams_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_IP_scope_reason_t? override_breached_media_streams_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_destination_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_destination_scope_code_t? override_breached_media_streams_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_destination_scope_reason_t? override_breached_media_streams_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_source_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_scope_code_t? override_breached_media_streams_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_source_scope_reason_t? override_breached_media_streams_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_media_streams_other_scope_response=null

Specifies the Reason header to include in the error response when rejecting a SIP request due to a capacity control per-call limit on concurrent media streams being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_other_scope_code_t? override_breached_media_streams_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_media_streams_other_scope_reason_t? override_breached_media_streams_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_code_t? override_breached_bandwidth_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_reason_t? override_breached_bandwidth_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_per_call_scope_code_t? override_breached_bandwidth_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_per_call_scope_reason_t? override_breached_bandwidth_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at the source number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_calling_number_scope_code_t? override_breached_bandwidth_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_calling_number_scope_reason_t? override_breached_bandwidth_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_IP_scope_code_t? override_breached_bandwidth_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_IP_scope_reason_t? override_breached_bandwidth_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_destination_scope_code_t? override_breached_bandwidth_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_destination_scope_reason_t? override_breached_bandwidth_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_scope_code_t? override_breached_bandwidth_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_source_scope_reason_t? override_breached_bandwidth_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_bandwidth_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on bidirectional bandwidth being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_other_scope_code_t? override_breached_bandwidth_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_bandwidth_other_scope_reason_t? override_breached_bandwidth_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_response=null

Determines whether this error profile specifies the default SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_code_t? override_breached_updates_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_reason_t? override_breached_updates_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_per_call_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at the per-call scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_per_call_scope_code_t? override_breached_updates_per_call_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_per_call_scope_reason_t? override_breached_updates_per_call_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_calling_number_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at the calling number scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_calling_number_scope_code_t? override_breached_updates_calling_number_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_calling_number_scope_reason_t? override_breached_updates_calling_number_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_source_IP_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at the source IP scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_IP_scope_code_t? override_breached_updates_source_IP_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_IP_scope_reason_t? override_breached_updates_source_IP_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_destination_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at the destination scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_destination_scope_code_t? override_breached_updates_destination_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_destination_scope_reason_t? override_breached_updates_destination_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_source_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at the source scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_scope_code_t? override_breached_updates_source_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_source_scope_reason_t? override_breached_updates_source_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool? override_breached_updates_other_scope_response=null

Determines whether this error profile specifies the SIP error code the Session Controller must use for SIP request rejections due to a capacity control limit on media renegotiations being breached at an unknown scope.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_other_scope_code_t? override_breached_updates_other_scope_code=null

Specifies the default SIP error code the Session Controller must generate when rejecting a SIP request for this reason.

attribute perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_override_breached_updates_other_scope_reason_t? override_breached_updates_other_scope_reason=null

Specifies the Reason header to include in the error response. You must specify a string of up to a maximum of 256 characters in the Reason header format set out in RFC 3326 as follows. protocol;cause=errorCode;text=”text” The string used for text must be enclosed in quotation marks, “, with the internal quotation marks escaped by . For example: “SIP;cause=500;text="example text"”

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_config

• perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_config, perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/error-profile/capacity-control-error-responses Perimeta API resource. Abstract base entity. For concrete usage, see children ErrorProfileCapacityControlErrorResponses and ErrorProfileCapacityControlErrorResponsesUnmanaged.

The capacity-control-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to a breach of capacity control limits on the adjacency to which the parent error-profile Resource is applied.

relation perimeta::sip_message_manipulation::ErrorProfileIdentity error_profile [1]

other end: perimeta::sip_message_manipulation::ErrorProfileIdentity.capacity_control_error_responses [0:1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_uri constraint true

entity perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesUnmanaged

Parents: perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesIdentity

Unmanaged reference to a /sip-message-manipulation/error-profile/capacity-control-error-responses Perimeta API resource.

The capacity-control-error-responses Resource determines the SIP error codes and (optionally) Reason headers that the Session Controller must use when rejecting SIP requests due to a breach of capacity control limits on the adjacency to which the parent error-profile Resource is applied.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::ErrorProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/error-profile Perimeta API resource. Abstract base entity. For concrete usage, see children ErrorProfile and ErrorProfileUnmanaged.

Configuration mode for a SIP error profile. An error profile defines a set of mappings between internal Session Controller errors and SIP response codes (and optionally reason text). For more information, see Configuring SIP error profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPErrorProfiles.html). For a list of internal error causes, see Default SIP error code mappings in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/DefaultSIPErrorCodeMappings.html).

Note: the following external error codes correspond to the given internal error causes. When the Session Controller receives one of these error codes, it carries out the mapping for the corresponding internal error cause and generates a new SIP response code.

• 404 - Call rejected during routing

• 410 - Call rejected during routing

• 484 - Call rejected by number analysis

• 485 - Call rejected during routing

• 604 - Call rejected during routing

For example, if the Session Controller receives a 404 error and you have configured this profile to map “Call rejected during routing” to the 503 error code, the Session Controller will generate a 503 error code.

Note: If you do not already use error profiles, Metaswitch recommends that you use SIP header profiles instead. Header profiles are more powerful and flexible than error profiles.

attribute perimeta::sip_message_manipulation::error_profile_profile_name_t profile_name

Specifies the name of the error profile.

relation perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesIdentity capacity_control_error_responses [0:1]

other end: perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponsesIdentity.error_profile [1]

relation perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesIdentity call_policy_set_error_responses [0:1]

other end: perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponsesIdentity.error_profile [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::error_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::error_profile_uri constraint true

entity perimeta::sip_message_manipulation::ErrorProfileUnmanaged

Parents: perimeta::sip_message_manipulation::ErrorProfileIdentity

Unmanaged reference to a /sip-message-manipulation/error-profile Perimeta API resource.

Configuration mode for a SIP error profile. An error profile defines a set of mappings between internal Session Controller errors and SIP response codes (and optionally reason text). For more information, see Configuring SIP error profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPErrorProfiles.html). For a list of internal error causes, see Default SIP error code mappings in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/DefaultSIPErrorCodeMappings.html).

Note: the following external error codes correspond to the given internal error causes. When the Session Controller receives one of these error codes, it carries out the mapping for the corresponding internal error cause and generates a new SIP response code.

• 404 - Call rejected during routing

• 410 - Call rejected during routing

• 484 - Call rejected by number analysis

• 485 - Call rejected during routing

• 604 - Call rejected during routing

For example, if the Session Controller receives a 404 error and you have configured this profile to map “Call rejected during routing” to the 503 error code, the Session Controller will generate a 503 error code.

Note: If you do not already use error profiles, Metaswitch recommends that you use SIP header profiles instead. Header profiles are more powerful and flexible than error profiles.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlist

Parents: perimeta::sip_message_manipulation::HeaderAllowlistIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-allowlist Perimeta API resource.

Creates and names a SIP header allowlist or selects the named allowlist if it already exists. The Session Controller will strip all headers from SIP messages that are not on this allowlist unless they are vital headers . For a list of vital headers, see SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderAllowlists.html). For more information on configuring SIP header allowlists, see Configuring SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderAllowlists.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::header_allowlist_description_t? description=null

Sets a description for the allowlist of up to 64 characters.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_allowlist_config

• perimeta::sip_message_manipulation::header_allowlist_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_allowlist_config, perimeta::sip_message_manipulation::header_allowlist_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlistHeader

Parents: perimeta::sip_message_manipulation::HeaderAllowlistHeaderIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-allowlist/header Perimeta API resource.

Adds a header to the allowlist. The Session Controller will pass through this header instead of stripping it.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_allowlist_header_config

• perimeta::sip_message_manipulation::header_allowlist_header_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_allowlist_header_config, perimeta::sip_message_manipulation::header_allowlist_header_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlistHeaderIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-allowlist/header Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderAllowlistHeader and HeaderAllowlistHeaderUnmanaged.

Adds a header to the allowlist. The Session Controller will pass through this header instead of stripping it.

attribute perimeta::sip_message_manipulation::header_allowlist_header_header_t header

Name of header to allow

relation perimeta::sip_message_manipulation::HeaderAllowlistIdentity header_allowlist [1]

other end: perimeta::sip_message_manipulation::HeaderAllowlistIdentity.header [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_allowlist_header_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_allowlist_header_uri constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlistHeaderUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderAllowlistHeaderIdentity

Unmanaged reference to a /sip-message-manipulation/header-allowlist/header Perimeta API resource.

Adds a header to the allowlist. The Session Controller will pass through this header instead of stripping it.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlistIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-allowlist Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderAllowlist and HeaderAllowlistUnmanaged.

Creates and names a SIP header allowlist or selects the named allowlist if it already exists. The Session Controller will strip all headers from SIP messages that are not on this allowlist unless they are vital headers . For a list of vital headers, see SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderAllowlists.html). For more information on configuring SIP header allowlists, see Configuring SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderAllowlists.html).

attribute perimeta::sip_message_manipulation::header_allowlist_header_allowlist_name_t header_allowlist_name

Name of the allowlist

relation perimeta::sip_message_manipulation::HeaderAllowlistHeaderIdentity header [0:*]

other end: perimeta::sip_message_manipulation::HeaderAllowlistHeaderIdentity.header_allowlist [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_allowlist_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_allowlist_uri constraint true

entity perimeta::sip_message_manipulation::HeaderAllowlistUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderAllowlistIdentity

Unmanaged reference to a /sip-message-manipulation/header-allowlist Perimeta API resource.

Creates and names a SIP header allowlist or selects the named allowlist if it already exists. The Session Controller will strip all headers from SIP messages that are not on this allowlist unless they are vital headers . For a list of vital headers, see SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderAllowlists.html). For more information on configuring SIP header allowlists, see Configuring SIP header allowlists in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderAllowlists.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfile

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-manipulation-profile Perimeta API resource.

Creates and names a header profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A header profile can contain a set of rules that manipulate the headers in SIP messages in various ways. For more information, see Configuring SIP header profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderProfiles.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_description_t? description=null

An optional text string describing this header profile.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_config

• perimeta::sip_message_manipulation::header_manipulation_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_config, perimeta::sip_message_manipulation::header_manipulation_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-manipulation-profile Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderManipulationProfile and HeaderManipulationProfileUnmanaged.

Creates and names a header profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A header profile can contain a set of rules that manipulate the headers in SIP messages in various ways. For more information, see Configuring SIP header profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderProfiles.html).

attribute perimeta::sip_message_manipulation::header_manipulation_profile_header_profile_t header_profile

A name for the header profile

relation perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleIdentity store_rule [0:*]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleIdentity.header_manipulation_profile [1]

relation perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleIdentity store_dialog_rule [0:*]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleIdentity.header_manipulation_profile [1]

relation perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleIdentity manipulation_rule [0:*]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleIdentity.header_manipulation_profile [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_uri constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRule

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-manipulation-profile/manipulation-rule Perimeta API resource.

Creates and names a rule in the header profile. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_description_t? description=null

Sets an optional description for the rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_action_t? action=null

The action that the Session Controller must take if this rule is matched.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_header_value_t? new_header_value=null

The value that will be used for the new header (if the action Property is set to add-first-header or add-header) or used to replace the value on the existing header (if the action Property is set to replace-header-value). This must be a text string of up to 256 characters. To include the value of a variable, enclose the variable name in {} characters preceded by a $ character. For example: ${msg.rmt_ip_addr}

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_header_name_t? new_header_name=null

The new name for the header.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_user_t? new_sip_uri_user=null

The value to use for part of a SIP URI.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_host_t? new_sip_uri_host=null

The value to use for part of a SIP URI.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_sip_uri_port_t? new_sip_uri_port=null

The value with which you want to replace the existing port part of the SIP URI in a header on which this rule matches. To include the value of a variable, enclose the variable name in {} characters preceded by a $ character. For example: ${msg.rmt_ip_addr}

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_tel_uri_t? new_tel_uri=null

The value with which you want to replace the existing number in the TEL URI in a header on which this rule matches. To include the value of a variable, enclose the variable name in {} characters preceded by a $ character. For example: ${msg.rmt_ip_addr}

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_new_uri_t? new_uri=null

The value with which you want to replace the existing SIP or TEL URI in a header on which this rule matches. To include the value of a variable, enclose the variable name in {} characters preceded by a $ character. For example: ${msg.rmt_ip_addr} The resulting URI must include the scheme. For example: sip:example@example.com

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_traffic_group_to_apply_t? traffic_group_to_apply=null

The traffic group to add to the call if this action is selected. Specify a string of up to 22 alphanumeric characters. This must be the name of a traffic group already configured on the Session Controller. For more information on traffic groups, see Traffic groups in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/TrafficGroups.html). You can only use a header profile to apply traffic groups based on the first message in a call and only during message manipulation on inbound adjacencies. If you try to apply traffic groups mid-call or during message manipulation on the outbound adjacency, the Session Controller ignores these attempts.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_category_to_add_t? category_to_add=null

The category which the Session Controller must assign to calls matching this rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_custom_category_t? custom_category=null

The custom category which the Session Controller must assign to calls matching this rule. Specify a string between 1 and 19 alphanumeric characters in length. This must not include cat.custom.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_termination_response_code_t? termination_response_code=null

The response code sent when an incoming SIP message matches this header profile

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_map_response_code_t? map_response_code=null

The SIP response code to map to

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_advanced_match_condition_t? advanced_match_condition=null

Sets the condition that must be met before the action is applied. For store-variables rules, this also specifies which information to store in which variables. For information on how to construct a condition string, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel apply_parameter_profile: The parameter profile to apply to the header type to which this rule applies. This parameter profile will be applied regardless of whether the condition specified in the advanced-match-condition Property is matched. Note that paraneter profiles can only be created and edited using the Perimeta command line interface (CLI).

relation perimeta::sip_message_manipulation::ParameterProfileIdentity apply_parameter_profile [0:1]

The parameter profile to apply to the header type to which this rule applies. This parameter profile will be applied

regardless of whether the condition specified in the advanced-match-condition Property is matched. Note that paraneter profiles can only be created and edited using the Perimeta command line interface (CLI).

Peer relation:

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_config

• perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_config, perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-manipulation-profile/manipulation-rule Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderManipulationProfileManipulationRule and HeaderManipulationProfileManipulationRuleUnmanaged.

Creates and names a rule in the header profile. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_sip_header_to_match_t sip_header_to_match

The header type to which this rule will apply.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_rule_index_t rule_index

A numerical index for the rule. This is used to differentiate between rules for the same header type and affects the order in which these rules are applied.

relation perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity header_manipulation_profile [1]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity.manipulation_rule [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_uri constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRuleIdentity

Unmanaged reference to a /sip-message-manipulation/header-manipulation-profile/manipulation-rule Perimeta API resource.

Creates and names a rule in the header profile. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRule

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-manipulation-profile/store-dialog-rule Perimeta API resource.

Creates and names a rule in the header profile. Variables stored by this rule are available for the call duration. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_description_t? description=null

Sets a description for the rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_t? store_dialog_rule=null

The condition string that must be matched for this rule to be applied. This string also specifies the information that will be stored and the names of the variables. For detailed information on constructing condition strings, see Condition strings and built-in variables for use in SIP header and action profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/ConditionStringsAndBuiltInVariablesForUseInSIPHeaderAndActionProfiles.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_config

• perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_config, perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-manipulation-profile/store-dialog-rule Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderManipulationProfileStoreDialogRule and HeaderManipulationProfileStoreDialogRuleUnmanaged.

Creates and names a rule in the header profile. Variables stored by this rule are available for the call duration. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_name_t store_dialog_rule_name

A name for this store dialog rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_store_dialog_rule_index_t store_dialog_rule_index

A numerical index for the rule. This is used to differentiate between store rules in the same header profile and affects the order in which these rules are applied. Although store rules do not manipulate headers, the order in which they are executed can be relevant because you can set conditions that depend on the values of variables or whether particular variables have been defined. Store rules are executed in order of header name, with the shortest name first. Multiple rules for a given header are executed in order of their index number, with the lowest number first.

relation perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity header_manipulation_profile [1]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity.store_dialog_rule [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_uri constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRuleIdentity

Unmanaged reference to a /sip-message-manipulation/header-manipulation-profile/store-dialog-rule Perimeta API resource.

Creates and names a rule in the header profile. Variables stored by this rule are available for the call duration. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRule

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/header-manipulation-profile/store-rule Perimeta API resource.

Creates and names a rule in the header profile. Variables stored by this rule are available to edit the current message only. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_description_t? description=null

Sets a description for the rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_t? store_rule=null

The condition string that must be matched for this rule to be applied. This string also specifies the information that will be stored and the names of the variables. For detailed information on constructing condition strings, see Condition strings and built-in variables for use in SIP header and action profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/ConditionStringsAndBuiltInVariablesForUseInSIPHeaderAndActionProfiles.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_config

• perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_config, perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/header-manipulation-profile/store-rule Perimeta API resource. Abstract base entity. For concrete usage, see children HeaderManipulationProfileStoreRule and HeaderManipulationProfileStoreRuleUnmanaged.

Creates and names a rule in the header profile. Variables stored by this rule are available to edit the current message only. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_name_t store_rule_name

A name for this store rule.

attribute perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_store_rule_index_t store_rule_index

A numerical index for the rule. This is used to differentiate between store rules in the same header profile and affects the order in which these rules are applied. Although store rules do not manipulate headers, the order in which they are executed can be relevant because you can set conditions that depend on the values of variables or whether particular variables have been defined. Store rules are executed in order of header name, with the shortest name first. Multiple rules for a given header are executed in order of their index number, with the lowest number first.

relation perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity header_manipulation_profile [1]

other end: perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity.store_rule [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_uri constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRuleIdentity

Unmanaged reference to a /sip-message-manipulation/header-manipulation-profile/store-rule Perimeta API resource.

Creates and names a rule in the header profile. Variables stored by this rule are available to edit the current message only. You can set the header type that the rule manipulates by specifying the header type in the rule name. You can specify an optional numerical index, which affects the order in which rules are applied. For more information, see SIP header profile details in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/References/SIPHeaderProfileDetails.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::HeaderManipulationProfileUnmanaged

Parents: perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity

Unmanaged reference to a /sip-message-manipulation/header-manipulation-profile Perimeta API resource.

Creates and names a header profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A header profile can contain a set of rules that manipulate the headers in SIP messages in various ways. For more information, see Configuring SIP header profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPHeaderProfiles.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::LuaConfigSet

Parents: perimeta::sip_message_manipulation::LuaConfigSetIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/lua-config-set Perimeta API resource.

Configuration mode for a Lua configuration set. This is a set of profiles created using the Lua scripting language to edit bodies of SIP messages passing through the Session Controller.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on Lua message body editing, see Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool? activate=null

Activate this Lua config set

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::lua_config_set_config

• perimeta::sip_message_manipulation::lua_config_set_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::lua_config_set_config, perimeta::sip_message_manipulation::lua_config_set_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::LuaConfigSetIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/lua-config-set Perimeta API resource. Abstract base entity. For concrete usage, see children LuaConfigSet and LuaConfigSetUnmanaged.

Configuration mode for a Lua configuration set. This is a set of profiles created using the Lua scripting language to edit bodies of SIP messages passing through the Session Controller.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on Lua message body editing, see Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

attribute perimeta::sip_message_manipulation::lua_config_set_lua_config_set_t lua_config_set

A unique number for the Lua config set

relation perimeta::sip_message_manipulation::LuaConfigSetLuaProfileIdentity lua_profile [0:*]

other end: perimeta::sip_message_manipulation::LuaConfigSetLuaProfileIdentity.lua_config_set [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::lua_config_set_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::lua_config_set_uri constraint true

entity perimeta::sip_message_manipulation::LuaConfigSetLuaProfile

Parents: perimeta::sip_message_manipulation::LuaConfigSetLuaProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/lua-config-set/lua-profile Perimeta API resource.

Configuration mode for a specific Lua profile within the parent Lua config set.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on the SIP MMF and Lua, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html) and Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-profile Resource that is a child of the lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::lua_config_set_lua_profile_content_type_t? content_type=null

Specifies whether the Session Controller must apply this profile only to messages with a specific Content-Type header value. You can choose to configure the Session Controller to apply this profile to all SIP messages, only to SIP messages with a specific Content-Type header value or only to SIP messages containing SDP. For more information, see Creating Lua profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/CreatingLuaProfiles.html).

attribute perimeta::sip_message_manipulation::lua_config_set_lua_profile_content_type_header_t? content_type_header=null

Apply this profile only to messages with a specific Content-Type header value. You must specify this value using the content-type-header Property.

attribute perimeta::sip_message_manipulation::lua_config_set_lua_profile_profile_code_t? profile_code=null

The code for the Lua profile. You can enter the code over multiple lines.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::lua_config_set_lua_profile_config

• perimeta::sip_message_manipulation::lua_config_set_lua_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::lua_config_set_lua_profile_config, perimeta::sip_message_manipulation::lua_config_set_lua_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::LuaConfigSetLuaProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/lua-config-set/lua-profile Perimeta API resource. Abstract base entity. For concrete usage, see children LuaConfigSetLuaProfile and LuaConfigSetLuaProfileUnmanaged.

Configuration mode for a specific Lua profile within the parent Lua config set.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on the SIP MMF and Lua, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html) and Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-profile Resource that is a child of the lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

attribute perimeta::sip_message_manipulation::lua_config_set_lua_profile_lua_profile_name_t lua_profile_name

A name for the Lua profile

relation perimeta::sip_message_manipulation::LuaConfigSetIdentity lua_config_set [1]

other end: perimeta::sip_message_manipulation::LuaConfigSetIdentity.lua_profile [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::lua_config_set_lua_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::lua_config_set_lua_profile_uri constraint true

entity perimeta::sip_message_manipulation::LuaConfigSetLuaProfileUnmanaged

Parents: perimeta::sip_message_manipulation::LuaConfigSetLuaProfileIdentity

Unmanaged reference to a /sip-message-manipulation/lua-config-set/lua-profile Perimeta API resource.

Configuration mode for a specific Lua profile within the parent Lua config set.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on the SIP MMF and Lua, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html) and Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-profile Resource that is a child of the lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::LuaConfigSetUnmanaged

Parents: perimeta::sip_message_manipulation::LuaConfigSetIdentity

Unmanaged reference to a /sip-message-manipulation/lua-config-set Perimeta API resource.

Configuration mode for a Lua configuration set. This is a set of profiles created using the Lua scripting language to edit bodies of SIP messages passing through the Session Controller.

Lua message body editing is designed for advanced users. Because it allows you to add, remove, or modify any information in the bodies of SIP messages passing through your Session Controller, errors in scripts or unexpected results can cause calls to fail and messages to be rejected. We recommend that you contact your Metaswitch support representative for advice before using Lua message body editing. For detailed information on Lua message body editing, see Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

You should not make changes to a lua-config-set Resource that is currently configured as the default Lua Config Set (as defined using the default-lua-config-set Property field on the sip-message-manipulation Resource), or any of its child lua-profile Resources. Instead, you should make a copy of this lua-config-set Resource and its child lua-profile Resources and then make any changes to the copies. Once you are satisfied with your changes, you should configure the copy lua-config-set Resource as the default Lua Config Set using the default-lua-config-set Property field on the sip-message-manipulation Resource.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfile

Parents: perimeta::sip_message_manipulation::MethodManipulationProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/method-manipulation-profile Perimeta API resource.

Creates and names a method profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A method profile can contain rules that apply to particular SIP methods, and rejects or passes them through. They can also invoke header or body profiles on particular methods. For more information, see Configuring SIP method profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPMethodProfiles.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::method_manipulation_profile_description_t? description=null

Sets a description for the method profile.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_config

• perimeta::sip_message_manipulation::method_manipulation_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_config, perimeta::sip_message_manipulation::method_manipulation_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/method-manipulation-profile Perimeta API resource. Abstract base entity. For concrete usage, see children MethodManipulationProfile and MethodManipulationProfileUnmanaged.

Creates and names a method profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A method profile can contain rules that apply to particular SIP methods, and rejects or passes them through. They can also invoke header or body profiles on particular methods. For more information, see Configuring SIP method profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPMethodProfiles.html).

attribute perimeta::sip_message_manipulation::method_manipulation_profile_method_profile_name_t method_profile_name

A name for the method profile.

relation perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleIdentity manipulation_rule [0:*]

other end: perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleIdentity.method_manipulation_profile [1]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_uri constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRule

Parents: perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/method-manipulation-profile/manipulation-rule Perimeta API resource.

The manipulation-rule Resource allows you to define a method rule that manipulates SIP messages with a particular method on adjacencies to which the parent SIP header profile is applied. A method rule is specified by the name of the method that it acts on. Each rule also includes a single action specifying what the rule does. Rules can optionally apply a header profile or body profile to messages with the specified method.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_action_t? action=null

The action that the Session Controller must take on messages with the method specified in this rule.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel apply_body_profile: The body profile to apply to messages using this method. :rel apply_header_profile: The header profile to apply to messages using this method. :rel apply_replacement_profile: The replacement profile to apply to messages using this method. Note that replacement profiles can only be created and edited using the Perimeta command line interface (CLI).

relation perimeta::sip_message_manipulation::BodyManipulationProfileIdentity apply_body_profile [0:1]

The body profile to apply to messages using this method. Peer relation:

relation perimeta::sip_message_manipulation::HeaderManipulationProfileIdentity apply_header_profile [0:1]

The header profile to apply to messages using this method. Peer relation:

relation perimeta::sip_message_manipulation::ReplacementProfileIdentity apply_replacement_profile [0:1]

The replacement profile to apply to messages using this method. Note that replacement profiles can only be created and

edited using the Perimeta command line interface (CLI).

Peer relation:

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_config

• perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_config, perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/method-manipulation-profile/manipulation-rule Perimeta API resource. Abstract base entity. For concrete usage, see children MethodManipulationProfileManipulationRule and MethodManipulationProfileManipulationRuleUnmanaged.

The manipulation-rule Resource allows you to define a method rule that manipulates SIP messages with a particular method on adjacencies to which the parent SIP header profile is applied. A method rule is specified by the name of the method that it acts on. Each rule also includes a single action specifying what the rule does. Rules can optionally apply a header profile or body profile to messages with the specified method.

attribute perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_sip_method_to_match_t sip_method_to_match

The SIP method type to which this rule will apply.

relation perimeta::sip_message_manipulation::MethodManipulationProfileIdentity method_manipulation_profile [1]

other end: perimeta::sip_message_manipulation::MethodManipulationProfileIdentity.manipulation_rule [0:*]

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_uri constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleUnmanaged

Parents: perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRuleIdentity

Unmanaged reference to a /sip-message-manipulation/method-manipulation-profile/manipulation-rule Perimeta API resource.

The manipulation-rule Resource allows you to define a method rule that manipulates SIP messages with a particular method on adjacencies to which the parent SIP header profile is applied. A method rule is specified by the name of the method that it acts on. Each rule also includes a single action specifying what the rule does. Rules can optionally apply a header profile or body profile to messages with the specified method.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::MethodManipulationProfileUnmanaged

Parents: perimeta::sip_message_manipulation::MethodManipulationProfileIdentity

Unmanaged reference to a /sip-message-manipulation/method-manipulation-profile Perimeta API resource.

Creates and names a method profile in the SIP Message Manipulation Framework, or selects the named profile if it already exists. A method profile can contain rules that apply to particular SIP methods, and rejects or passes them through. They can also invoke header or body profiles on particular methods. For more information, see Configuring SIP method profiles in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Tasks/ConfiguringSIPMethodProfiles.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::ParameterProfile

Parents: perimeta::sip_message_manipulation::ParameterProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/parameter-profile Perimeta API resource.

This resource represents a parameter profile in the SIP Message Manipulation Framework. A parameter profile can only be invoked by a reference from a header profile and can contain rules that strip, rewrite, add or pass through particular URI parameters in the To, From, or Contact headers.

You can only create and edit parameter profiles through the Perimeta command line interface (CLI). However, you can configure rules in a header profile to invoke existing parameter profiles over the REST API, using the apply-parameter-profile Property.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::parameter_profile_config

• perimeta::sip_message_manipulation::parameter_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::parameter_profile_config, perimeta::sip_message_manipulation::parameter_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::ParameterProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/parameter-profile Perimeta API resource. Abstract base entity. For concrete usage, see children ParameterProfile and ParameterProfileUnmanaged.

This resource represents a parameter profile in the SIP Message Manipulation Framework. A parameter profile can only be invoked by a reference from a header profile and can contain rules that strip, rewrite, add or pass through particular URI parameters in the To, From, or Contact headers.

You can only create and edit parameter profiles through the Perimeta command line interface (CLI). However, you can configure rules in a header profile to invoke existing parameter profiles over the REST API, using the apply-parameter-profile Property.

attribute perimeta::sip_message_manipulation::parameter_profile_profile_name_t profile_name

Specifies the name of the parameter profile.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::parameter_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::parameter_profile_uri constraint true

entity perimeta::sip_message_manipulation::ParameterProfileUnmanaged

Parents: perimeta::sip_message_manipulation::ParameterProfileIdentity

Unmanaged reference to a /sip-message-manipulation/parameter-profile Perimeta API resource.

This resource represents a parameter profile in the SIP Message Manipulation Framework. A parameter profile can only be invoked by a reference from a header profile and can contain rules that strip, rewrite, add or pass through particular URI parameters in the To, From, or Contact headers.

You can only create and edit parameter profiles through the Perimeta command line interface (CLI). However, you can configure rules in a header profile to invoke existing parameter profiles over the REST API, using the apply-parameter-profile Property.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::ReplacementProfile

Parents: perimeta::sip_message_manipulation::ReplacementProfileIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation/replacement-profile Perimeta API resource.

This resource represents a replacement profile in the SIP Message Manipulation Framework. Replaacement profiles can be used to find and replace strings inside SIP messages.

You can only create and edit replacement profiles through the Perimeta command line interface (CLI). However, you can use the REST API to configure rules in a method or body profile to invoke existing replacement profiles by setting the apply-replacement-profile Property.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::replacement_profile_config

• perimeta::sip_message_manipulation::replacement_profile_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::replacement_profile_config, perimeta::sip_message_manipulation::replacement_profile_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::ReplacementProfileIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation/replacement-profile Perimeta API resource. Abstract base entity. For concrete usage, see children ReplacementProfile and ReplacementProfileUnmanaged.

This resource represents a replacement profile in the SIP Message Manipulation Framework. Replaacement profiles can be used to find and replace strings inside SIP messages.

You can only create and edit replacement profiles through the Perimeta command line interface (CLI). However, you can use the REST API to configure rules in a method or body profile to invoke existing replacement profiles by setting the apply-replacement-profile Property.

attribute perimeta::sip_message_manipulation::replacement_profile_profile_name_t profile_name

Specifies the name of the replacement profile

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::replacement_profile_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::replacement_profile_uri constraint true

entity perimeta::sip_message_manipulation::ReplacementProfileUnmanaged

Parents: perimeta::sip_message_manipulation::ReplacementProfileIdentity

Unmanaged reference to a /sip-message-manipulation/replacement-profile Perimeta API resource.

This resource represents a replacement profile in the SIP Message Manipulation Framework. Replaacement profiles can be used to find and replace strings inside SIP messages.

You can only create and edit replacement profiles through the Perimeta command line interface (CLI). However, you can use the REST API to configure rules in a method or body profile to invoke existing replacement profiles by setting the apply-replacement-profile Property.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_message_manipulation::SipMessageManipulation

Parents: perimeta::sip_message_manipulation::SipMessageManipulationIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-message-manipulation Perimeta API resource.

Configuration mode for SIP Message Manipulation Framework message editing profiles. For more information, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing. :rel default_lua_config_set: Sets the global default lua configuration set, which specifies a set of Lua profiles available for editing the bodies of SIP messages on adjacencies. For more information on Lua message body editing, see Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

relation perimeta::sip_message_manipulation::LuaConfigSetIdentity default_lua_config_set [0:1]

Sets the global default lua configuration set, which specifies a set of Lua profiles available for editing the bodies of

SIP messages on adjacencies. For more information on Lua message body editing, see Lua message body editing in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/LuaSDPEditing.html).

Peer relation:

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::sip_message_manipulation_config

• perimeta::sip_message_manipulation::sip_message_manipulation_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::sip_message_manipulation_config, perimeta::sip_message_manipulation::sip_message_manipulation_cross_device_relations constraint true

entity perimeta::sip_message_manipulation::SipMessageManipulationIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-message-manipulation Perimeta API resource. Abstract base entity. For concrete usage, see children SipMessageManipulation and SipMessageManipulationUnmanaged.

Configuration mode for SIP Message Manipulation Framework message editing profiles. For more information, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html).

The following implementations are defined for this entity:

• perimeta::sip_message_manipulation::sip_message_manipulation_uri

The following implements statements select implementations for this entity:

• perimeta::sip_message_manipulation::sip_message_manipulation_uri constraint true

entity perimeta::sip_message_manipulation::SipMessageManipulationUnmanaged

Parents: perimeta::sip_message_manipulation::SipMessageManipulationIdentity

Unmanaged reference to a /sip-message-manipulation Perimeta API resource.

Configuration mode for SIP Message Manipulation Framework message editing profiles. For more information, see SIP Message Manipulation Framework in Perimeta Advanced Message Editing Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/AdvancedMessageEditing/Source/Perimeta/Concepts/SIPMessageManipulationFramework.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_signing_service::SipSigningService

Parents: perimeta::sip_signing_service::SipSigningServiceIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-signing-service Perimeta API resource.

Creates a connection to a remote signing service (a server or pool of servers) to use for SIP request signing.

You must connect the Session Controller to a signing service if you want to enable SIP request signing.

When SIP request signing is enabled, the Session Controller sends signing requests for outbound INVITEs that meet the following conditions to the signing service.

• The INVITE does not already have an Identity header, and is therefore unsigned.

• The call has a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number.

• The call has a P-Origination-Id header. This specifies the originator of the signing request.

If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE.

When you have configured the connection to the remote signing service, you must enable SIP request signing with the sip-signing command.

Perimeta Session Controllers can add the P-Attestation-Indicator and P-Origination-Id headers to calls before forwarding them into your core network. To configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope.

For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_signing_service::sip_signing_service_ca_certificate_t? ca_certificate=null

Specifies the CA certificate to use for HTTPS requests to the service. This must have been configured on the Session Controller as described in Importing the public certificate of a certification authority in Perimeta Configuration And Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ImportingThePublicCertificateOfACertificationAuthority.html). The CA certificate and the service’s public certificate must be valid for both the primary server and the backup server (if configured).

attribute perimeta::sip_signing_service::sip_signing_service_remote_url_t? remote_url=null

Specifies the address of the primary server (or pool of servers) in your SIP signing service that the Session Controller will send signing requests to. This must be a valid URL and include http:// or https://. You can optionally specify a port using :Port syntax. The default port is 80 for HTTP and 443 for HTTPS. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::sip_signing_service::sip_signing_service_secondary_remote_url_t? secondary_remote_url=null

Specifies the URL of the backup SIP signing server or pool of servers that the Session Controller will send requests to if the primary signing server is unavailable. This must be a valid URL and include http:// or https://. You can optionally specify a port using :Port syntax. The default port is 80 for HTTP and 443 for HTTPS. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::sip_signing_service::sip_signing_service_service_address_t? service_address=null

Specifies the name of the local service address on the Session Controller to use to send signing requests to a signing service (a server or pool of servers). This service address must be configured on the system. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::sip_signing_service::sip_signing_service_timeout_t? timeout=null

Specifies the timeout for the connection to the remote signing service (a server or pool of servers), in milliseconds. This should be significantly lower than the timeout for INVITEs,so your Session Controller can continue to set up the call even if the signing server cannot be contacted. For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_signing_service::sip_signing_service_config

• perimeta::sip_signing_service::sip_signing_service_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_signing_service::sip_signing_service_config, perimeta::sip_signing_service::sip_signing_service_cross_device_relations constraint true

entity perimeta::sip_signing_service::SipSigningServiceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-signing-service Perimeta API resource. Abstract base entity. For concrete usage, see children SipSigningService and SipSigningServiceUnmanaged.

Creates a connection to a remote signing service (a server or pool of servers) to use for SIP request signing.

You must connect the Session Controller to a signing service if you want to enable SIP request signing.

When SIP request signing is enabled, the Session Controller sends signing requests for outbound INVITEs that meet the following conditions to the signing service.

• The INVITE does not already have an Identity header, and is therefore unsigned.

• The call has a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number.

• The call has a P-Origination-Id header. This specifies the originator of the signing request.

If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE.

When you have configured the connection to the remote signing service, you must enable SIP request signing with the sip-signing command.

Perimeta Session Controllers can add the P-Attestation-Indicator and P-Origination-Id headers to calls before forwarding them into your core network. To configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope.

For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

attribute perimeta::sip_signing_service::sip_signing_service_sip_signing_service_t sip_signing_service

The following implementations are defined for this entity:

• perimeta::sip_signing_service::sip_signing_service_uri

The following implements statements select implementations for this entity:

• perimeta::sip_signing_service::sip_signing_service_uri constraint true

entity perimeta::sip_signing_service::SipSigningServiceUnmanaged

Parents: perimeta::sip_signing_service::SipSigningServiceIdentity

Unmanaged reference to a /sip-signing-service Perimeta API resource.

Creates a connection to a remote signing service (a server or pool of servers) to use for SIP request signing.

You must connect the Session Controller to a signing service if you want to enable SIP request signing.

When SIP request signing is enabled, the Session Controller sends signing requests for outbound INVITEs that meet the following conditions to the signing service.

• The INVITE does not already have an Identity header, and is therefore unsigned.

• The call has a P-Attestation-Indicator header. This specifies the level of trust assigned to the calling number.

• The call has a P-Origination-Id header. This specifies the originator of the signing request.

If the signing service responds with a token and signature, Perimeta inserts an Identity header with the token and signature into the INVITE.

When you have configured the connection to the remote signing service, you must enable SIP request signing with the sip-signing command.

Perimeta Session Controllers can add the P-Attestation-Indicator and P-Origination-Id headers to calls before forwarding them into your core network. To configure this, you must use the header-settings p-attestation-indicator and header-settings p-origination-id properties at the global default, interoperability profile or adjacency scope.

For more information on request signing, see SIP request signing in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestSigning.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::sip_verification_service::SipVerificationService

Parents: perimeta::sip_verification_service::SipVerificationServiceIdentity, std::PurgeableResource

Inmanta resource to manage a /sip-verification-service Perimeta API resource.

Creates a connection to a remote verification service (a server or pool of servers) to use for SIP verification.

You must connect the Session Controller a verification service if you want to enable SIP request verification.

When SIP request verification is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the verification service.

If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header.

When you have configured the connection to the remote verification service, you must enable SIP request verification with the sip-verification property. To add the verstat value to a P-Asserted-Identity or From header, you must use the header-settings verstat property. These are available at the global default, interoperability profile or adjacency scope.

For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::sip_verification_service::sip_verification_service_ca_certificate_t? ca_certificate=null

Specifies the CA certificate to use for HTTPS requests to the service. This must be have been configured on the Session Controller as described in Importing the public certificate of a certification authority in Perimeta Configuration And Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ImportingThePublicCertificateOfACertificationAuthority.html). The CA certificate and the service’s public certificate must be valid for both the primary server and the backup server (if configured).

attribute perimeta::sip_verification_service::sip_verification_service_remote_url_t? remote_url=null

Specifies the address of the primary server (or pool of servers) in your SIP verification service that the Session Controller will send verification requests to. This must be a valid URL and include http:// or https://. You can optionally specify a port using :Port syntax. The default port is 80 for HTTP and 443 for HTTPS. For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::sip_verification_service::sip_verification_service_secondary_remote_url_t? secondary_remote_url=null

Specifies the URL of the backup SIP verification server or pool of servers that the Session Controller will send requests to if the primary verification server is unavailable. This must be a valid URL and include http:// or https://. You can optionally specify a port using :Port syntax. The default port is 80 for HTTP and 443 for HTTPS. For more information on request signing, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::sip_verification_service::sip_verification_service_service_address_t? service_address=null

Specifies the name of the local service address on the Session Controller to use to send requests to the SIP verification service (a server or pool of servers). This service address must be configured on the system. For more information on request signing, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::sip_verification_service::sip_verification_service_timeout_t? timeout=null

Specifies the timeout for the connection to the remote verification service (a server or pool of servers), in milliseconds. This should be significantly lower than the timeout for INVITEs,so your Session Controller can continue to set up the call even if the verification service cannot be contacted. For more information on request signing, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::sip_verification_service::sip_verification_service_config

• perimeta::sip_verification_service::sip_verification_service_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::sip_verification_service::sip_verification_service_config, perimeta::sip_verification_service::sip_verification_service_cross_device_relations constraint true

entity perimeta::sip_verification_service::SipVerificationServiceIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /sip-verification-service Perimeta API resource. Abstract base entity. For concrete usage, see children SipVerificationService and SipVerificationServiceUnmanaged.

Creates a connection to a remote verification service (a server or pool of servers) to use for SIP verification.

You must connect the Session Controller a verification service if you want to enable SIP request verification.

When SIP request verification is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the verification service.

If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header.

When you have configured the connection to the remote verification service, you must enable SIP request verification with the sip-verification property. To add the verstat value to a P-Asserted-Identity or From header, you must use the header-settings verstat property. These are available at the global default, interoperability profile or adjacency scope.

For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

attribute perimeta::sip_verification_service::sip_verification_service_sip_verification_service_t sip_verification_service

The following implementations are defined for this entity:

• perimeta::sip_verification_service::sip_verification_service_uri

The following implements statements select implementations for this entity:

• perimeta::sip_verification_service::sip_verification_service_uri constraint true

entity perimeta::sip_verification_service::SipVerificationServiceUnmanaged

Parents: perimeta::sip_verification_service::SipVerificationServiceIdentity

Unmanaged reference to a /sip-verification-service Perimeta API resource.

Creates a connection to a remote verification service (a server or pool of servers) to use for SIP verification.

You must connect the Session Controller a verification service if you want to enable SIP request verification.

When SIP request verification is enabled, the Session Controller sends verification requests for inbounds INVITEs with Identity headers to the verification service.

If the verification service responds with a verstat value, the Session Controller uses this value and, optionally, the attestation level (the level of trust) indicated in the Identity header to determine a verstat value to add to a P-Asserted-Identity or From header.

When you have configured the connection to the remote verification service, you must enable SIP request verification with the sip-verification property. To add the verstat value to a P-Asserted-Identity or From header, you must use the header-settings verstat property. These are available at the global default, interoperability profile or adjacency scope.

For more information on request verification, see SIP request verification in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Concepts/RequestVerification.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::tls_ciphers::TlsCiphers

Parents: perimeta::tls_ciphers::TlsCiphersIdentity, std::PurgeableResource

Inmanta resource to manage a /tls-ciphers Perimeta API resource.

Allows you to configure which TLS cipher suites the Session Controller uses when encrypting SIP, MSRP or HTTP, as either a server or a client. This only applies to TLSv1.2 and earlier. For example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html).

If a request to change TLS cipher suites fails (for example because the request included an invalid cipher suite), the Session Controller reapplies your existing cipher suite configuration. The reapplication requires restarting the Session Controller’s internal HTTP(S) server, which provides the REST API. The Session Controller will send 503 “Configuration is currently unavailable” responses to requests over the configuration API during this process.

For more details about the cause of the failure, download a diagnostis package and inspect system/logs/hatch/hatch.inttrc.log.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::tls_ciphers::tls_ciphers_service_traffic_client_t? service_traffic_client=null

Allows you to set the cipher suites in use when the Session Controller acts as a SIP or MSRP client and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute bool? service_traffic_client_use_default=null

Allows you to set the cipher suites in use when the Session Controller acts as a SIP or MSRP client and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute perimeta::tls_ciphers::tls_ciphers_service_traffic_server_t? service_traffic_server=null

Allows you to set the cipher suites in use when the Session Controller acts as a SIP or MSRP server and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute bool? service_traffic_server_use_default=null

Allows you to set the cipher suites in use when the Session Controller acts as a SIP or MSRP server and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute perimeta::tls_ciphers::tls_ciphers_management_https_server_t? management_https_server=null

Allows you to set the cipher suites in use when the Session Controller acts as a HTTPS server and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute bool? management_https_server_use_default=null

Allows you to set the cipher suites in use when the Session Controller acts as a HTTPS server and uses TLSv1.2 or earlier. Set the enabled cipher suites by inputting an OpenSSL-formatted string specifying all the cipher suites enabled for this scenario. When connecting to other devices in this role, the Session Controller will only use these specified cipher suites. For configuration instructions and example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html). The cipher lists here allow removing or supporting less secure ciphers used in TLSv1.2 and earlier to balance security and compatibility. Note that TLSv1.3 only supports strong ciphersuites and these are not affected by this command. The cipher list must be enclosed in “ “ because it contains special characters.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::tls_ciphers::tls_ciphers_config

• perimeta::tls_ciphers::tls_ciphers_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::tls_ciphers::tls_ciphers_config, perimeta::tls_ciphers::tls_ciphers_cross_device_relations constraint true

entity perimeta::tls_ciphers::TlsCiphersIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /tls-ciphers Perimeta API resource. Abstract base entity. For concrete usage, see children TlsCiphers and TlsCiphersUnmanaged.

Allows you to configure which TLS cipher suites the Session Controller uses when encrypting SIP, MSRP or HTTP, as either a server or a client. This only applies to TLSv1.2 and earlier. For example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html).

If a request to change TLS cipher suites fails (for example because the request included an invalid cipher suite), the Session Controller reapplies your existing cipher suite configuration. The reapplication requires restarting the Session Controller’s internal HTTP(S) server, which provides the REST API. The Session Controller will send 503 “Configuration is currently unavailable” responses to requests over the configuration API during this process.

For more details about the cause of the failure, download a diagnostis package and inspect system/logs/hatch/hatch.inttrc.log.

The following implementations are defined for this entity:

• perimeta::tls_ciphers::tls_ciphers_uri

The following implements statements select implementations for this entity:

• perimeta::tls_ciphers::tls_ciphers_uri constraint true

entity perimeta::tls_ciphers::TlsCiphersUnmanaged

Parents: perimeta::tls_ciphers::TlsCiphersIdentity

Unmanaged reference to a /tls-ciphers Perimeta API resource.

Allows you to configure which TLS cipher suites the Session Controller uses when encrypting SIP, MSRP or HTTP, as either a server or a client. This only applies to TLSv1.2 and earlier. For example strings, see Configuring cipher suite support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringCipherSuiteSupport.html).

If a request to change TLS cipher suites fails (for example because the request included an invalid cipher suite), the Session Controller reapplies your existing cipher suite configuration. The reapplication requires restarting the Session Controller’s internal HTTP(S) server, which provides the REST API. The Session Controller will send 503 “Configuration is currently unavailable” responses to requests over the configuration API during this process.

For more details about the cause of the failure, download a diagnostis package and inspect system/logs/hatch/hatch.inttrc.log.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::tls_min_versions::TlsMinVersions

Parents: perimeta::tls_min_versions::TlsMinVersionsIdentity, std::PurgeableResource

Inmanta resource to manage a /tls-min-versions Perimeta API resource.

Allows you to set the minimum version of TLS that the Session Controller will allow when connecting to other devices.

Use these settings to set the minimum TLS version allowed for service traffic over SIP and MSRP, and for HTTPS connections.

For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html). Note that these commands also affects lawful interception traffic in deployments with lawful interception enabled.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::tls_min_versions::tls_min_versions_management_https_server_t? management_https_server=null

Allows you to set the minimum version of TLS that the Session Controller will allow for HTTPS connections. The Session Controller will reject all attempts to connect using TLS versions lower than the one set here. For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html).

attribute bool? management_https_server_use_default=null

Allows you to set the minimum version of TLS that the Session Controller will allow for HTTPS connections. The Session Controller will reject all attempts to connect using TLS versions lower than the one set here. For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html).

attribute perimeta::tls_min_versions::tls_min_versions_service_traffic_t? service_traffic=null

Allows you to set the minimum version of TLS that the Session Controller will allow when connecting to SIP or MSRP connections. The Session Controller will reject all attempts to connect using TLS versions lower than the one set here. For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html). Note that this command also affects lawful interception traffic in deployments with lawful interception enabled.

attribute bool? service_traffic_use_default=null

Allows you to set the minimum version of TLS that the Session Controller will allow when connecting to SIP or MSRP connections. The Session Controller will reject all attempts to connect using TLS versions lower than the one set here. For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html). Note that this command also affects lawful interception traffic in deployments with lawful interception enabled.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::tls_min_versions::tls_min_versions_config

• perimeta::tls_min_versions::tls_min_versions_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::tls_min_versions::tls_min_versions_config, perimeta::tls_min_versions::tls_min_versions_cross_device_relations constraint true

entity perimeta::tls_min_versions::TlsMinVersionsIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /tls-min-versions Perimeta API resource. Abstract base entity. For concrete usage, see children TlsMinVersions and TlsMinVersionsUnmanaged.

Allows you to set the minimum version of TLS that the Session Controller will allow when connecting to other devices.

Use these settings to set the minimum TLS version allowed for service traffic over SIP and MSRP, and for HTTPS connections.

For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html). Note that these commands also affects lawful interception traffic in deployments with lawful interception enabled.

The following implementations are defined for this entity:

• perimeta::tls_min_versions::tls_min_versions_uri

The following implements statements select implementations for this entity:

• perimeta::tls_min_versions::tls_min_versions_uri constraint true

entity perimeta::tls_min_versions::TlsMinVersionsUnmanaged

Parents: perimeta::tls_min_versions::TlsMinVersionsIdentity

Unmanaged reference to a /tls-min-versions Perimeta API resource.

Allows you to set the minimum version of TLS that the Session Controller will allow when connecting to other devices.

Use these settings to set the minimum TLS version allowed for service traffic over SIP and MSRP, and for HTTPS connections.

For configuration instructions, see Configuring TLS version support in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSVersionSupport.html). Note that these commands also affects lawful interception traffic in deployments with lawful interception enabled.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::tls_security_level::TlsSecurityLevel

Parents: perimeta::tls_security_level::TlsSecurityLevelIdentity, std::PurgeableResource

Inmanta resource to manage a /tls-security-level Perimeta API resource.

Configuration mode for the Session Controller’s TLS security level. Your Session Controller’s TLS security level determines which kinds of TLS connections it allows for service traffic over SIP and MSRP. The Session Controller rejects TLS connections that do not meet the criteria of the TLS security level set by these commands. These commands also affect lawful interception traffic in deployments with lawful interception enabled. For configuration instructions and information on the kinds of TLS connections each security level restricts, see Configuring TLS security levels in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSSecurityLevels.html).

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::tls_security_level::tls_security_level_service_traffic_t? service_traffic=null

Sets the minimum TLS security level that the Session Controller allows for service traffic connections over SIP and MSRP.

attribute bool? service_traffic_use_default=null

Sets the minimum TLS security level that the Session Controller allows for service traffic connections over SIP and MSRP.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::tls_security_level::tls_security_level_config

• perimeta::tls_security_level::tls_security_level_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::tls_security_level::tls_security_level_config, perimeta::tls_security_level::tls_security_level_cross_device_relations constraint true

entity perimeta::tls_security_level::TlsSecurityLevelIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /tls-security-level Perimeta API resource. Abstract base entity. For concrete usage, see children TlsSecurityLevel and TlsSecurityLevelUnmanaged.

Configuration mode for the Session Controller’s TLS security level. Your Session Controller’s TLS security level determines which kinds of TLS connections it allows for service traffic over SIP and MSRP. The Session Controller rejects TLS connections that do not meet the criteria of the TLS security level set by these commands. These commands also affect lawful interception traffic in deployments with lawful interception enabled. For configuration instructions and information on the kinds of TLS connections each security level restricts, see Configuring TLS security levels in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSSecurityLevels.html).

The following implementations are defined for this entity:

• perimeta::tls_security_level::tls_security_level_uri

The following implements statements select implementations for this entity:

• perimeta::tls_security_level::tls_security_level_uri constraint true

entity perimeta::tls_security_level::TlsSecurityLevelUnmanaged

Parents: perimeta::tls_security_level::TlsSecurityLevelIdentity

Unmanaged reference to a /tls-security-level Perimeta API resource.

Configuration mode for the Session Controller’s TLS security level. Your Session Controller’s TLS security level determines which kinds of TLS connections it allows for service traffic over SIP and MSRP. The Session Controller rejects TLS connections that do not meet the criteria of the TLS security level set by these commands. These commands also affect lawful interception traffic in deployments with lawful interception enabled. For configuration instructions and information on the kinds of TLS connections each security level restricts, see Configuring TLS security levels in Perimeta Configuration and Interoperability Guide - CLI Users (https://manuals.metaswitch.com/Perimeta/latest/ConfigurationAndInterop/Source/Perimeta/Tasks/ConfiguringTLSSecurityLevels.html).

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::tunnel::Peer

Parents: perimeta::tunnel::PeerIdentity, std::PurgeableResource

Inmanta resource to manage a /tunnel/peer Perimeta API resource.

Specify a peer

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::tunnel::peer_peer_port_t? peer_port=null

Set the remote port this peer listens on, which Perimeta will also listen for traffic from this peer on.

attribute bool? peer_port_use_default=null

Set the remote port this peer listens on, which Perimeta will also listen for traffic from this peer on.

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::tunnel::peer_config

• perimeta::tunnel::peer_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::tunnel::peer_config, perimeta::tunnel::peer_cross_device_relations constraint true

entity perimeta::tunnel::PeerIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /tunnel/peer Perimeta API resource. Abstract base entity. For concrete usage, see children Peer and PeerUnmanaged.

Specify a peer

attribute std::ipv_any_address peer_address

IP address

relation perimeta::tunnel::TunnelIdentity tunnel [1]

other end: perimeta::tunnel::TunnelIdentity.peer [0:*]

The following implementations are defined for this entity:

• perimeta::tunnel::peer_uri

The following implements statements select implementations for this entity:

• perimeta::tunnel::peer_uri constraint true

entity perimeta::tunnel::PeerUnmanaged

Parents: perimeta::tunnel::PeerIdentity

Unmanaged reference to a /tunnel/peer Perimeta API resource.

Specify a peer

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

entity perimeta::tunnel::Tunnel

Parents: perimeta::tunnel::TunnelIdentity, std::PurgeableResource

Inmanta resource to manage a /tunnel Perimeta API resource.

Configures a VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

Unset attributes (or attributes set to null) are not managed and are left untouched on the API. Relations are always fully managed: unset relations represent the intent to unset them on the API as well.

Children must use parents’ implementations.

attribute perimeta::tunnel::tunnel_encapsulation_t encapsulation

Set how traffic on this tunnel is encapsulated

attribute perimeta::tunnel::tunnel_vni_t vni

VXLAN Network Identifier (VNI)

attribute perimeta::tunnel::tunnel_local_address_type_t local_address_type

Local address for the tunnel to use

attribute perimeta::tunnel::tunnel_per_instance_address_t? per_instance_address=null

Per-instance address for the tunnel to use

attribute perimeta::tunnel::tunnel_service_address_t? service_address=null

Service address for the tunnel to use

attribute bool? activate=null

Activate tunnel

attribute bool report_only=false

When the flag is set to true, and change is detected during deployment, the global resource will fail instead of applying these changes. Starting from ISO9, the resource will be marked as non-compliant instead of failing.

The following implementations are defined for this entity:

• perimeta::tunnel::tunnel_config

• perimeta::tunnel::tunnel_cross_device_relations

The following implements statements select implementations for this entity:

• perimeta::tunnel::tunnel_config, perimeta::tunnel::tunnel_cross_device_relations constraint true

entity perimeta::tunnel::TunnelIdentity

Parents: perimeta::PerimetaApiObject

Identifying entity for a /tunnel Perimeta API resource. Abstract base entity. For concrete usage, see children Tunnel and TunnelUnmanaged.

Configures a VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

attribute perimeta::tunnel::tunnel_tunnel_name_t tunnel_name

Tunnel name

relation perimeta::tunnel::PeerIdentity peer [0:*]

other end: perimeta::tunnel::PeerIdentity.tunnel [1]

The following implementations are defined for this entity:

• perimeta::tunnel::tunnel_uri

The following implements statements select implementations for this entity:

• perimeta::tunnel::tunnel_uri constraint true

entity perimeta::tunnel::TunnelUnmanaged

Parents: perimeta::tunnel::TunnelIdentity

Unmanaged reference to a /tunnel Perimeta API resource.

Configures a VXLAN tunnel. Two Perimeta VM instances functioning as a high availability pair in Azure require virtual extensible local area network (VXLAN) tunnels, which allow Ethernet traffic to be transferred over an IP network. If you configure VXLAN tunnels, you must also configure service interfaces for the overlay and underlay networks. For more information, see VXLANs in Azure in Metaswitch Products Azure Deployment Design Guide.

Using VXLAN tunnels reduces Perimeta’s overall media capacity. For more information on using VXLANs with Perimeta, see Planning network interfaces for high availability with VXLANs in Perimeta Initial Setup and Commissioning Guide (Azure, Distributed deployment) or in Perimeta Initial Setup and Commissioning Guide (Azure, Integrated deployment), depending on your type of deployment.

This is not an inmanta resource. It may be used to create (managed) references to unmanaged API resources.

The following implements statements select implementations for this entity:

• perimeta::unmanaged constraint true

Implementations

implementation perimeta::unmanaged

implementation perimeta::account::account_config

implementation perimeta::account::account_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::account_limits_config

implementation perimeta::account::account_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::account_limits_uri

implementation perimeta::account::account_uri

implementation perimeta::account::call_limits_config

implementation perimeta::account::call_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::call_limits_uri

implementation perimeta::account::call_media_policy_config

implementation perimeta::account::call_media_policy_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::call_media_policy_uri

implementation perimeta::account::traffic_group_call_limits_config

implementation perimeta::account::traffic_group_call_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::traffic_group_call_limits_uri

implementation perimeta::account::traffic_group_call_media_policy_config

implementation perimeta::account::traffic_group_call_media_policy_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::traffic_group_call_media_policy_uri

implementation perimeta::account::traffic_group_config

implementation perimeta::account::traffic_group_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::traffic_group_traffic_group_limits_config

implementation perimeta::account::traffic_group_traffic_group_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::account::traffic_group_traffic_group_limits_uri

implementation perimeta::account::traffic_group_uri

implementation perimeta::address_group::address_group_config

implementation perimeta::address_group::address_group_cross_device_relations

Guard against cross-device references.

implementation perimeta::address_group::address_group_uri

implementation perimeta::address_group::ip_address_config

implementation perimeta::address_group::ip_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::address_group::ip_address_uri

implementation perimeta::adjacency::sip_adjacency_limits_config

implementation perimeta::adjacency::sip_adjacency_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_adjacency_limits_uri

implementation perimeta::adjacency::sip_call_limits_config

implementation perimeta::adjacency::sip_call_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_call_limits_uri

implementation perimeta::adjacency::sip_call_media_policy_config

implementation perimeta::adjacency::sip_call_media_policy_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_call_media_policy_uri

implementation perimeta::adjacency::sip_config

implementation perimeta::adjacency::sip_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_delegate_authentication_config

implementation perimeta::adjacency::sip_delegate_authentication_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_delegate_authentication_uri

implementation perimeta::adjacency::sip_interop_config

implementation perimeta::adjacency::sip_interop_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_interop_uri

implementation perimeta::adjacency::sip_traffic_group_call_limits_config

implementation perimeta::adjacency::sip_traffic_group_call_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_traffic_group_call_limits_uri

implementation perimeta::adjacency::sip_traffic_group_call_media_policy_config

implementation perimeta::adjacency::sip_traffic_group_call_media_policy_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_traffic_group_call_media_policy_uri

implementation perimeta::adjacency::sip_traffic_group_config

implementation perimeta::adjacency::sip_traffic_group_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_traffic_group_traffic_group_limits_config

implementation perimeta::adjacency::sip_traffic_group_traffic_group_limits_cross_device_relations

Guard against cross-device references.

implementation perimeta::adjacency::sip_traffic_group_traffic_group_limits_uri

implementation perimeta::adjacency::sip_traffic_group_uri

implementation perimeta::adjacency::sip_uri

implementation perimeta::ca_public_certificate_store::ca_certificate_config

implementation perimeta::ca_public_certificate_store::ca_certificate_cross_device_relations

Guard against cross-device references.

implementation perimeta::ca_public_certificate_store::ca_certificate_uri

implementation perimeta::ca_public_certificate_store::ca_public_certificate_store_config

implementation perimeta::ca_public_certificate_store::ca_public_certificate_store_cross_device_relations

Guard against cross-device references.

implementation perimeta::ca_public_certificate_store::ca_public_certificate_store_uri

implementation perimeta::call_policy_set::call_policy_set_config

implementation perimeta::call_policy_set::call_policy_set_cross_device_relations

Guard against cross-device references.

implementation perimeta::call_policy_set::call_policy_set_uri

implementation perimeta::call_policy_set::routing_table_config

implementation perimeta::call_policy_set::routing_table_cross_device_relations

Guard against cross-device references.

implementation perimeta::call_policy_set::routing_table_entry_config

implementation perimeta::call_policy_set::routing_table_entry_cross_device_relations

Guard against cross-device references.

implementation perimeta::call_policy_set::routing_table_entry_uri

implementation perimeta::call_policy_set::routing_table_uri

implementation perimeta::called_number::called_number_config

implementation perimeta::called_number::called_number_cross_device_relations

Guard against cross-device references.

implementation perimeta::called_number::called_number_uri

implementation perimeta::codec_list::codec_list_config

implementation perimeta::codec_list::codec_list_cross_device_relations

Guard against cross-device references.

implementation perimeta::codec_list::codec_list_uri

implementation perimeta::codec_list::entry_config

implementation perimeta::codec_list::entry_cross_device_relations

Guard against cross-device references.

implementation perimeta::codec_list::entry_uri

implementation perimeta::custom_codec::dynamic_payload_type_config

implementation perimeta::custom_codec::dynamic_payload_type_cross_device_relations

Guard against cross-device references.

implementation perimeta::custom_codec::dynamic_payload_type_uri

implementation perimeta::custom_codec::static_payload_type_config

implementation perimeta::custom_codec::static_payload_type_cross_device_relations

Guard against cross-device references.

implementation perimeta::custom_codec::static_payload_type_uri

implementation perimeta::delegate_subscriber::delegate_subscriber_config

implementation perimeta::delegate_subscriber::delegate_subscriber_cross_device_relations

Guard against cross-device references.

implementation perimeta::delegate_subscriber::delegate_subscriber_uri

implementation perimeta::delegate_subscriber::sip_contact_config

implementation perimeta::delegate_subscriber::sip_contact_cross_device_relations

Guard against cross-device references.

implementation perimeta::delegate_subscriber::sip_contact_uri

implementation perimeta::diagnostics::diagnostics_config

implementation perimeta::diagnostics::diagnostics_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::diagnostics_uri

implementation perimeta::diagnostics::marker_adjacency_config

implementation perimeta::diagnostics::marker_adjacency_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::marker_adjacency_uri

implementation perimeta::diagnostics::marker_number_config

implementation perimeta::diagnostics::marker_number_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::marker_number_uri

implementation perimeta::diagnostics::marker_remote_ip_config

implementation perimeta::diagnostics::marker_remote_ip_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::marker_remote_ip_uri

implementation perimeta::diagnostics::marker_service_network_config

implementation perimeta::diagnostics::marker_service_network_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::marker_service_network_uri

implementation perimeta::diagnostics::marker_uri_config

implementation perimeta::diagnostics::marker_uri_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::marker_uri_uri

implementation perimeta::diagnostics::service_assurance_config

implementation perimeta::diagnostics::service_assurance_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::service_assurance_sas_config

implementation perimeta::diagnostics::service_assurance_sas_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::service_assurance_sas_uri

implementation perimeta::diagnostics::service_assurance_uri

implementation perimeta::diagnostics::upload_server_config

implementation perimeta::diagnostics::upload_server_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::upload_server_uri

implementation perimeta::diagnostics::ves_event_reporting_config

implementation perimeta::diagnostics::ves_event_reporting_cross_device_relations

Guard against cross-device references.

implementation perimeta::diagnostics::ves_event_reporting_uri

implementation perimeta::guard::list_guard

implementation perimeta::inbound_tunnel::inbound_tunnel_config

implementation perimeta::inbound_tunnel::inbound_tunnel_cross_device_relations

Guard against cross-device references.

implementation perimeta::inbound_tunnel::inbound_tunnel_uri

implementation perimeta::inbound_tunnel::peer_config

implementation perimeta::inbound_tunnel::peer_cross_device_relations

Guard against cross-device references.

implementation perimeta::inbound_tunnel::peer_uri

implementation perimeta::interop_defaults::interop_defaults_config

implementation perimeta::interop_defaults::interop_defaults_cross_device_relations

Guard against cross-device references.

implementation perimeta::interop_defaults::interop_defaults_uri

implementation perimeta::interop_profile::interop_profile_config

implementation perimeta::interop_profile::interop_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::interop_profile::interop_profile_uri

implementation perimeta::ip_access_control::blocklist_application_per_address_config

implementation perimeta::ip_access_control::blocklist_application_per_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_application_per_address_uri

implementation perimeta::ip_access_control::blocklist_application_per_port_config

implementation perimeta::ip_access_control::blocklist_application_per_port_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_application_per_port_specific_address_config

implementation perimeta::ip_access_control::blocklist_application_per_port_specific_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_application_per_port_specific_address_uri

implementation perimeta::ip_access_control::blocklist_application_per_port_uri

implementation perimeta::ip_access_control::blocklist_application_service_network_config

implementation perimeta::ip_access_control::blocklist_application_service_network_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_application_service_network_uri

implementation perimeta::ip_access_control::blocklist_application_specific_address_config

implementation perimeta::ip_access_control::blocklist_application_specific_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_application_specific_address_uri

implementation perimeta::ip_access_control::blocklist_profile_config

implementation perimeta::ip_access_control::blocklist_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::blocklist_profile_uri

implementation perimeta::ip_access_control::trusted_sources_address_config

implementation perimeta::ip_access_control::trusted_sources_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::trusted_sources_address_uri

implementation perimeta::ip_access_control::trusted_sources_range_config

implementation perimeta::ip_access_control::trusted_sources_range_cross_device_relations

Guard against cross-device references.

implementation perimeta::ip_access_control::trusted_sources_range_uri

implementation perimeta::ipsec_peer::crypto_algorithms_proposal_config

implementation perimeta::ipsec_peer::crypto_algorithms_proposal_cross_device_relations

Guard against cross-device references.

implementation perimeta::ipsec_peer::crypto_algorithms_proposal_uri

implementation perimeta::ipsec_peer::ipsec_peer_config

implementation perimeta::ipsec_peer::ipsec_peer_cross_device_relations

Guard against cross-device references.

implementation perimeta::ipsec_peer::ipsec_peer_uri

implementation perimeta::ipsec_peer::remote_peer_inner_ip_address_range_config

implementation perimeta::ipsec_peer::remote_peer_inner_ip_address_range_cross_device_relations

Guard against cross-device references.

implementation perimeta::ipsec_peer::remote_peer_inner_ip_address_range_uri

implementation perimeta::media_address::ip_config

implementation perimeta::media_address::ip_cross_device_relations

Guard against cross-device references.

implementation perimeta::media_address::ip_port_range_config

implementation perimeta::media_address::ip_port_range_cross_device_relations

Guard against cross-device references.

implementation perimeta::media_address::ip_port_range_uri

implementation perimeta::media_address::ip_uri

implementation perimeta::media_address::pool_config

implementation perimeta::media_address::pool_cross_device_relations

Guard against cross-device references.

implementation perimeta::media_address::pool_port_range_config

implementation perimeta::media_address::pool_port_range_cross_device_relations

Guard against cross-device references.

implementation perimeta::media_address::pool_port_range_uri

implementation perimeta::media_address::pool_uri

implementation perimeta::media_realm_group::media_realm_group_config

implementation perimeta::media_realm_group::media_realm_group_cross_device_relations

Guard against cross-device references.

implementation perimeta::media_realm_group::media_realm_group_uri

implementation perimeta::peer_group_sip::peer_config

implementation perimeta::peer_group_sip::peer_cross_device_relations

Guard against cross-device references.

implementation perimeta::peer_group_sip::peer_group_sip_config

implementation perimeta::peer_group_sip::peer_group_sip_cross_device_relations

Guard against cross-device references.

implementation perimeta::peer_group_sip::peer_group_sip_uri

implementation perimeta::peer_group_sip::peer_uri

implementation perimeta::priority_call_media_limit::priority_call_media_limit_config

implementation perimeta::priority_call_media_limit::priority_call_media_limit_cross_device_relations

Guard against cross-device references.

implementation perimeta::priority_call_media_limit::priority_call_media_limit_uri

implementation perimeta::priority_category::priority_category_config

implementation perimeta::priority_category::priority_category_cross_device_relations

Guard against cross-device references.

implementation perimeta::priority_category::priority_category_uri

implementation perimeta::priority_category::resource_priority_header_match_config

implementation perimeta::priority_category::resource_priority_header_match_cross_device_relations

Guard against cross-device references.

implementation perimeta::priority_category::resource_priority_header_match_uri

implementation perimeta::priority_category::rn_pattern_match_config

implementation perimeta::priority_category::rn_pattern_match_cross_device_relations

Guard against cross-device references.

implementation perimeta::priority_category::rn_pattern_match_uri

implementation perimeta::priority_category::uri_pattern_match_config

implementation perimeta::priority_category::uri_pattern_match_cross_device_relations

Guard against cross-device references.

implementation perimeta::priority_category::uri_pattern_match_uri

implementation perimeta::push_notification_service::push_notification_service_config

implementation perimeta::push_notification_service::push_notification_service_cross_device_relations

Guard against cross-device references.

implementation perimeta::push_notification_service::push_notification_service_uri

implementation perimeta::qos::msrp_config

implementation perimeta::qos::msrp_cross_device_relations

Guard against cross-device references.

implementation perimeta::qos::msrp_uri

implementation perimeta::qos::sig_config

implementation perimeta::qos::sig_cross_device_relations

Guard against cross-device references.

implementation perimeta::qos::sig_uri

implementation perimeta::qos::video_config

implementation perimeta::qos::video_cross_device_relations

Guard against cross-device references.

implementation perimeta::qos::video_uri

implementation perimeta::qos::voice_config

implementation perimeta::qos::voice_cross_device_relations

Guard against cross-device references.

implementation perimeta::qos::voice_uri

implementation perimeta::routing::routing_config

implementation perimeta::routing::routing_cross_device_relations

Guard against cross-device references.

implementation perimeta::routing::routing_uri

implementation perimeta::service_interface::ipv4_config

implementation perimeta::service_interface::ipv4_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::ipv4_local_ip_address_config

implementation perimeta::service_interface::ipv4_local_ip_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::ipv4_local_ip_address_uri

implementation perimeta::service_interface::ipv4_per_instance_address_config

implementation perimeta::service_interface::ipv4_per_instance_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::ipv4_per_instance_address_uri

implementation perimeta::service_interface::ipv4_uri

implementation perimeta::service_interface::ipv6_config

implementation perimeta::service_interface::ipv6_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::ipv6_local_ip_address_config

implementation perimeta::service_interface::ipv6_local_ip_address_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::ipv6_local_ip_address_uri

implementation perimeta::service_interface::ipv6_uri

implementation perimeta::service_interface::service_interface_config

implementation perimeta::service_interface::service_interface_cross_device_relations

Guard against cross-device references.

implementation perimeta::service_interface::service_interface_uri

implementation perimeta::signaling::signaling_config

implementation perimeta::signaling::signaling_cross_device_relations

Guard against cross-device references.

implementation perimeta::signaling::signaling_uri

implementation perimeta::sip_generic_stream_list::sip_generic_stream_list_config

implementation perimeta::sip_generic_stream_list::sip_generic_stream_list_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_generic_stream_list::sip_generic_stream_list_uri

implementation perimeta::sip_message_manipulation::body_manipulation_profile_config

implementation perimeta::sip_message_manipulation::body_manipulation_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::body_manipulation_profile_rule_config

implementation perimeta::sip_message_manipulation::body_manipulation_profile_rule_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::body_manipulation_profile_rule_uri

implementation perimeta::sip_message_manipulation::body_manipulation_profile_uri

implementation perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_config

implementation perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::error_profile_call_policy_set_error_responses_uri

implementation perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_config

implementation perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::error_profile_capacity_control_error_responses_uri

implementation perimeta::sip_message_manipulation::error_profile_config

implementation perimeta::sip_message_manipulation::error_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::error_profile_uri

implementation perimeta::sip_message_manipulation::header_allowlist_config

implementation perimeta::sip_message_manipulation::header_allowlist_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_allowlist_header_config

implementation perimeta::sip_message_manipulation::header_allowlist_header_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_allowlist_header_uri

implementation perimeta::sip_message_manipulation::header_allowlist_uri

implementation perimeta::sip_message_manipulation::header_manipulation_profile_config

implementation perimeta::sip_message_manipulation::header_manipulation_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_config

implementation perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_manipulation_profile_manipulation_rule_uri

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_config

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_dialog_rule_uri

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_config

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::header_manipulation_profile_store_rule_uri

implementation perimeta::sip_message_manipulation::header_manipulation_profile_uri

implementation perimeta::sip_message_manipulation::lua_config_set_config

implementation perimeta::sip_message_manipulation::lua_config_set_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::lua_config_set_lua_profile_config

implementation perimeta::sip_message_manipulation::lua_config_set_lua_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::lua_config_set_lua_profile_uri

implementation perimeta::sip_message_manipulation::lua_config_set_uri

implementation perimeta::sip_message_manipulation::method_manipulation_profile_config

implementation perimeta::sip_message_manipulation::method_manipulation_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_config

implementation perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::method_manipulation_profile_manipulation_rule_uri

implementation perimeta::sip_message_manipulation::method_manipulation_profile_uri

implementation perimeta::sip_message_manipulation::parameter_profile_config

implementation perimeta::sip_message_manipulation::parameter_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::parameter_profile_uri

implementation perimeta::sip_message_manipulation::replacement_profile_config

implementation perimeta::sip_message_manipulation::replacement_profile_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::replacement_profile_uri

implementation perimeta::sip_message_manipulation::sip_message_manipulation_config

implementation perimeta::sip_message_manipulation::sip_message_manipulation_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_message_manipulation::sip_message_manipulation_uri

implementation perimeta::sip_signing_service::sip_signing_service_config

implementation perimeta::sip_signing_service::sip_signing_service_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_signing_service::sip_signing_service_uri

implementation perimeta::sip_verification_service::sip_verification_service_config

implementation perimeta::sip_verification_service::sip_verification_service_cross_device_relations

Guard against cross-device references.

implementation perimeta::sip_verification_service::sip_verification_service_uri

implementation perimeta::tls_ciphers::tls_ciphers_config

implementation perimeta::tls_ciphers::tls_ciphers_cross_device_relations

Guard against cross-device references.

implementation perimeta::tls_ciphers::tls_ciphers_uri

implementation perimeta::tls_min_versions::tls_min_versions_config

implementation perimeta::tls_min_versions::tls_min_versions_cross_device_relations

Guard against cross-device references.

implementation perimeta::tls_min_versions::tls_min_versions_uri

implementation perimeta::tls_security_level::tls_security_level_config

implementation perimeta::tls_security_level::tls_security_level_cross_device_relations

Guard against cross-device references.

implementation perimeta::tls_security_level::tls_security_level_uri

implementation perimeta::tunnel::peer_config

implementation perimeta::tunnel::peer_cross_device_relations

Guard against cross-device references.

implementation perimeta::tunnel::peer_uri

implementation perimeta::tunnel::tunnel_config

implementation perimeta::tunnel::tunnel_cross_device_relations

Guard against cross-device references.

implementation perimeta::tunnel::tunnel_uri

Plugins

perimeta.is_under_collection(collection_uri: <class 'str'>, item_uri: <class 'str'>) → <class 'bool'>

Return true iff item_uri is located under the collection_uri container. Used to validate that the items a ListGuard manages actually live in the collection it guards.

perimeta.url_part_quote(value: str | int) → <class 'str'>

Replace special characters in string using the %xx escape. Intended to be used for parts of the path section of a URL. Must not be used to quote the full path, because slashes are also escaped.

Resources

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::Account

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::AccountLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::CallLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::CallMediaPolicy

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::TrafficGroup

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::TrafficGroupCallLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::TrafficGroupCallMediaPolicy

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::account::TrafficGroupTrafficGroupLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::address_group::AddressGroup

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::address_group::IpAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::Sip

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipAdjacencyLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipCallLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipCallMediaPolicy

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipDelegateAuthentication

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipInterop

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipTrafficGroup

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipTrafficGroupCallLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipTrafficGroupCallMediaPolicy

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::adjacency::SipTrafficGroupTrafficGroupLimits

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ca_public_certificate_store::CaCertificate

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ca_public_certificate_store::CaPublicCertificateStore

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::call_policy_set::CallPolicySet

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::call_policy_set::RoutingTable

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::call_policy_set::RoutingTableEntry

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::called_number::CalledNumber

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::codec_list::CodecList

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::codec_list::Entry

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::custom_codec::DynamicPayloadType

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::custom_codec::StaticPayloadType

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::delegate_subscriber::DelegateSubscriber

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::delegate_subscriber::SipContact

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::Diagnostics

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::MarkerAdjacency

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::MarkerNumber

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::MarkerRemoteIp

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::MarkerServiceNetwork

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::MarkerUri

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::ServiceAssurance

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::ServiceAssuranceSas

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::UploadServer

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::diagnostics::VesEventReporting

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.ListGuardResource

Resource that prunes unmanaged members from a Perimeta list/collection. Its uri is the collection container, and managed_uris is the set of member URIs that the model owns. Any member on the device that is not in managed_uris is removed.

• Resource for entity perimeta::guard::ListGuard

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.ListGuardHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::inbound_tunnel::InboundTunnel

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::inbound_tunnel::Peer

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::interop_defaults::InteropDefaults

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::interop_profile::InteropProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistApplicationPerAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistApplicationPerPort

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistApplicationServiceNetwork

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistApplicationSpecificAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::BlocklistProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::TrustedSourcesAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ip_access_control::TrustedSourcesRange

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ipsec_peer::CryptoAlgorithmsProposal

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ipsec_peer::IpsecPeer

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::ipsec_peer::RemotePeerInnerIpAddressRange

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::media_address::Ip

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::media_address::IpPortRange

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::media_address::Pool

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::media_address::PoolPortRange

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::media_realm_group::MediaRealmGroup

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::peer_group_sip::Peer

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::peer_group_sip::PeerGroupSip

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::priority_call_media_limit::PriorityCallMediaLimit

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::priority_category::PriorityCategory

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::priority_category::ResourcePriorityHeaderMatch

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::priority_category::RnPatternMatch

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::priority_category::UriPatternMatch

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::push_notification_service::PushNotificationService

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::qos::Msrp

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::qos::Sig

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::qos::Video

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::qos::Voice

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::routing::Routing

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::Ipv4

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::Ipv4LocalIpAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::Ipv4PerInstanceAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::Ipv6

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::Ipv6LocalIpAddress

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::service_interface::ServiceInterface

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::signaling::Signaling

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_generic_stream_list::SipGenericStreamList

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::BodyManipulationProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::BodyManipulationProfileRule

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::ErrorProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponses

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponses

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderAllowlist

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderAllowlistHeader

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderManipulationProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRule

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRule

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRule

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::LuaConfigSet

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::LuaConfigSetLuaProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::MethodManipulationProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRule

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::ParameterProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::ReplacementProfile

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_message_manipulation::SipMessageManipulation

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_signing_service::SipSigningService

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::sip_verification_service::SipVerificationService

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::tls_ciphers::TlsCiphers

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::tls_min_versions::TlsMinVersions

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::tls_security_level::TlsSecurityLevel

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::tunnel::Peer

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

class perimeta.PerimetaResource

Generic resource for Perimeta API resources. Maps one on one with an API resource.

• Resource for entity perimeta::tunnel::Tunnel

• Id attribute uri

• Agent name device.agent_name

• Handlers perimeta.PerimetaHandler

Handlers

class perimeta.ListGuardHandler

Handler that prunes unmanaged members from a guarded Perimeta collection.

It enumerates the collection’s actual members (the _children returned by a GET on the container) and deletes any member whose URI is not in the resource’s managed_uris. When the resource is in report_only mode, the drift is reported as non-compliant but nothing is deleted (handled by the CRUDHandler base).

• Handler for entity perimeta::guard::ListGuard

class perimeta.PerimetaHandler

Generic handler for Perimeta API resources.

• Handler for entity perimeta::account::Account

• Handler for entity perimeta::account::AccountLimits

• Handler for entity perimeta::account::CallLimits

• Handler for entity perimeta::account::CallMediaPolicy

• Handler for entity perimeta::account::TrafficGroup

• Handler for entity perimeta::account::TrafficGroupCallLimits

• Handler for entity perimeta::account::TrafficGroupCallMediaPolicy

• Handler for entity perimeta::account::TrafficGroupTrafficGroupLimits

• Handler for entity perimeta::address_group::AddressGroup

• Handler for entity perimeta::address_group::IpAddress

• Handler for entity perimeta::adjacency::Sip

• Handler for entity perimeta::adjacency::SipAdjacencyLimits

• Handler for entity perimeta::adjacency::SipCallLimits

• Handler for entity perimeta::adjacency::SipCallMediaPolicy

• Handler for entity perimeta::adjacency::SipDelegateAuthentication

• Handler for entity perimeta::adjacency::SipInterop

• Handler for entity perimeta::adjacency::SipTrafficGroup

• Handler for entity perimeta::adjacency::SipTrafficGroupCallLimits

• Handler for entity perimeta::adjacency::SipTrafficGroupCallMediaPolicy

• Handler for entity perimeta::adjacency::SipTrafficGroupTrafficGroupLimits

• Handler for entity perimeta::ca_public_certificate_store::CaCertificate

• Handler for entity perimeta::ca_public_certificate_store::CaPublicCertificateStore

• Handler for entity perimeta::call_policy_set::CallPolicySet

• Handler for entity perimeta::call_policy_set::RoutingTable

• Handler for entity perimeta::call_policy_set::RoutingTableEntry

• Handler for entity perimeta::called_number::CalledNumber

• Handler for entity perimeta::codec_list::CodecList

• Handler for entity perimeta::codec_list::Entry

• Handler for entity perimeta::custom_codec::DynamicPayloadType

• Handler for entity perimeta::custom_codec::StaticPayloadType

• Handler for entity perimeta::delegate_subscriber::DelegateSubscriber

• Handler for entity perimeta::delegate_subscriber::SipContact

• Handler for entity perimeta::diagnostics::Diagnostics

• Handler for entity perimeta::diagnostics::MarkerAdjacency

• Handler for entity perimeta::diagnostics::MarkerNumber

• Handler for entity perimeta::diagnostics::MarkerRemoteIp

• Handler for entity perimeta::diagnostics::MarkerServiceNetwork

• Handler for entity perimeta::diagnostics::MarkerUri

• Handler for entity perimeta::diagnostics::ServiceAssurance

• Handler for entity perimeta::diagnostics::ServiceAssuranceSas

• Handler for entity perimeta::diagnostics::UploadServer

• Handler for entity perimeta::diagnostics::VesEventReporting

• Handler for entity perimeta::inbound_tunnel::InboundTunnel

• Handler for entity perimeta::inbound_tunnel::Peer

• Handler for entity perimeta::interop_defaults::InteropDefaults

• Handler for entity perimeta::interop_profile::InteropProfile

• Handler for entity perimeta::ip_access_control::BlocklistApplicationPerAddress

• Handler for entity perimeta::ip_access_control::BlocklistApplicationPerPort

• Handler for entity perimeta::ip_access_control::BlocklistApplicationPerPortSpecificAddress

• Handler for entity perimeta::ip_access_control::BlocklistApplicationServiceNetwork

• Handler for entity perimeta::ip_access_control::BlocklistApplicationSpecificAddress

• Handler for entity perimeta::ip_access_control::BlocklistProfile

• Handler for entity perimeta::ip_access_control::TrustedSourcesAddress

• Handler for entity perimeta::ip_access_control::TrustedSourcesRange

• Handler for entity perimeta::ipsec_peer::CryptoAlgorithmsProposal

• Handler for entity perimeta::ipsec_peer::IpsecPeer

• Handler for entity perimeta::ipsec_peer::RemotePeerInnerIpAddressRange

• Handler for entity perimeta::media_address::Ip

• Handler for entity perimeta::media_address::IpPortRange

• Handler for entity perimeta::media_address::Pool

• Handler for entity perimeta::media_address::PoolPortRange

• Handler for entity perimeta::media_realm_group::MediaRealmGroup

• Handler for entity perimeta::peer_group_sip::Peer

• Handler for entity perimeta::peer_group_sip::PeerGroupSip

• Handler for entity perimeta::priority_call_media_limit::PriorityCallMediaLimit

• Handler for entity perimeta::priority_category::PriorityCategory

• Handler for entity perimeta::priority_category::ResourcePriorityHeaderMatch

• Handler for entity perimeta::priority_category::RnPatternMatch

• Handler for entity perimeta::priority_category::UriPatternMatch

• Handler for entity perimeta::push_notification_service::PushNotificationService

• Handler for entity perimeta::qos::Msrp

• Handler for entity perimeta::qos::Sig

• Handler for entity perimeta::qos::Video

• Handler for entity perimeta::qos::Voice

• Handler for entity perimeta::routing::Routing

• Handler for entity perimeta::service_interface::Ipv4

• Handler for entity perimeta::service_interface::Ipv4LocalIpAddress

• Handler for entity perimeta::service_interface::Ipv4PerInstanceAddress

• Handler for entity perimeta::service_interface::Ipv6

• Handler for entity perimeta::service_interface::Ipv6LocalIpAddress

• Handler for entity perimeta::service_interface::ServiceInterface

• Handler for entity perimeta::signaling::Signaling

• Handler for entity perimeta::sip_generic_stream_list::SipGenericStreamList

• Handler for entity perimeta::sip_message_manipulation::BodyManipulationProfile

• Handler for entity perimeta::sip_message_manipulation::BodyManipulationProfileRule

• Handler for entity perimeta::sip_message_manipulation::ErrorProfile

• Handler for entity perimeta::sip_message_manipulation::ErrorProfileCallPolicySetErrorResponses

• Handler for entity perimeta::sip_message_manipulation::ErrorProfileCapacityControlErrorResponses

• Handler for entity perimeta::sip_message_manipulation::HeaderAllowlist

• Handler for entity perimeta::sip_message_manipulation::HeaderAllowlistHeader

• Handler for entity perimeta::sip_message_manipulation::HeaderManipulationProfile

• Handler for entity perimeta::sip_message_manipulation::HeaderManipulationProfileManipulationRule

• Handler for entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreDialogRule

• Handler for entity perimeta::sip_message_manipulation::HeaderManipulationProfileStoreRule

• Handler for entity perimeta::sip_message_manipulation::LuaConfigSet

• Handler for entity perimeta::sip_message_manipulation::LuaConfigSetLuaProfile

• Handler for entity perimeta::sip_message_manipulation::MethodManipulationProfile

• Handler for entity perimeta::sip_message_manipulation::MethodManipulationProfileManipulationRule

• Handler for entity perimeta::sip_message_manipulation::ParameterProfile

• Handler for entity perimeta::sip_message_manipulation::ReplacementProfile

• Handler for entity perimeta::sip_message_manipulation::SipMessageManipulation

• Handler for entity perimeta::sip_signing_service::SipSigningService

• Handler for entity perimeta::sip_verification_service::SipVerificationService

• Handler for entity perimeta::tls_ciphers::TlsCiphers

• Handler for entity perimeta::tls_min_versions::TlsMinVersions

• Handler for entity perimeta::tls_security_level::TlsSecurityLevel

• Handler for entity perimeta::tunnel::Peer

• Handler for entity perimeta::tunnel::Tunnel