Skip to content

vnmonitoring.oracle.com/v1beta1

Back to API Reference

APIVersion: vnmonitoring.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes vnmonitoring.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
PathAnalyzerTest Namespaced Sample -

PathAnalyzerTest

Manage OCI Network Monitoring path analyzer tests.

  • Plural: pathanalyzertests
  • Scope: Namespaced
  • APIVersion: vnmonitoring.oracle.com/v1beta1
  • Sample: Sample (config/samples/vnmonitoring_v1beta1_pathanalyzertest.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PathAnalyzerTestSpec defines the desired state of PathAnalyzerTest.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the PathAnalyzerTest resource's compartment. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
destinationEndpoint PathAnalyzerTestDestinationEndpoint defines nested fields for PathAnalyzerTest.DestinationEndpoint. object Yes - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
protocol The IP protocol to use in the PathAnalyzerTest resource. integer Yes - -
protocolParameters PathAnalyzerTestProtocolParameters defines nested fields for PathAnalyzerTest.ProtocolParameters. object No - -
queryOptions PathAnalyzerTestQueryOptions defines nested fields for PathAnalyzerTest.QueryOptions. object No - -
sourceEndpoint PathAnalyzerTestSourceEndpoint defines nested fields for PathAnalyzerTest.SourceEndpoint. object Yes - -

Spec.destinationEndpoint

Back to PathAnalyzerTest spec

PathAnalyzerTestDestinationEndpoint defines nested fields for PathAnalyzerTest.DestinationEndpoint.

Field Description Type Required Default Enum
address The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object. string No - -
instanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. string No - -
jsonData - string No - -
listenerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. string No - -
loadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer. string No - -
networkLoadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. string No - -
psaId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. string No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). string No - -
type - string No - -
vlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). string No - -
vnicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. string No - -

Spec.protocolParameters

Back to PathAnalyzerTest spec

PathAnalyzerTestProtocolParameters defines nested fields for PathAnalyzerTest.ProtocolParameters.

Field Description Type Required Default Enum
destinationPort The destination port to use in a PathAnalyzerTest resource. integer No - -
icmpCode The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. integer No - -
icmpType The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. integer No - -
jsonData - string No - -
sourcePort The source port to use in a PathAnalyzerTest resource. integer No - -
type - string No - -

Spec.queryOptions

Back to PathAnalyzerTest spec

PathAnalyzerTestQueryOptions defines nested fields for PathAnalyzerTest.QueryOptions.

Field Description Type Required Default Enum
isBiDirectionalAnalysis If true, a path analysis is done for both the forward and reverse routes. boolean No - -

Spec.sourceEndpoint

Back to PathAnalyzerTest spec

PathAnalyzerTestSourceEndpoint defines nested fields for PathAnalyzerTest.SourceEndpoint.

Field Description Type Required Default Enum
address The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object. string No - -
instanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. string No - -
jsonData - string No - -
listenerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. string No - -
loadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer. string No - -
networkLoadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. string No - -
psaId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. string No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). string No - -
type - string No - -
vlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). string No - -
vnicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. string No - -

Status

PathAnalyzerTestStatus defines the observed state of PathAnalyzerTest.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PathAnalyzerTest resource's compartment. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
destinationEndpoint PathAnalyzerTestDestinationEndpoint defines nested fields for PathAnalyzerTest.DestinationEndpoint. object No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id A unique identifier established when the resource is created. The identifier can't be changed later. string No - -
lifecycleState The current state of the PathAnalyzerTest resource. string No - -
protocol The IP protocol to use for the PathAnalyzerTest resource. integer No - -
protocolParameters PathAnalyzerTestProtocolParameters defines nested fields for PathAnalyzerTest.ProtocolParameters. object No - -
queryOptions PathAnalyzerTestQueryOptions defines nested fields for PathAnalyzerTest.QueryOptions. object No - -
sourceEndpoint PathAnalyzerTestSourceEndpoint defines nested fields for PathAnalyzerTest.SourceEndpoint. object No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the PathAnalyzerTest resource was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -
timeUpdated The date and time the PathAnalyzerTest resource was last updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -

Status.destinationEndpoint

Back to PathAnalyzerTest status

PathAnalyzerTestDestinationEndpoint defines nested fields for PathAnalyzerTest.DestinationEndpoint.

Field Description Type Required Default Enum
address The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object. string No - -
instanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. string No - -
jsonData - string No - -
listenerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. string No - -
loadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer. string No - -
networkLoadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. string No - -
psaId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. string No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). string No - -
type - string No - -
vlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). string No - -
vnicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. string No - -

Status.protocolParameters

Back to PathAnalyzerTest status

PathAnalyzerTestProtocolParameters defines nested fields for PathAnalyzerTest.ProtocolParameters.

Field Description Type Required Default Enum
destinationPort The destination port to use in a PathAnalyzerTest resource. integer No - -
icmpCode The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. integer No - -
icmpType The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. integer No - -
jsonData - string No - -
sourcePort The source port to use in a PathAnalyzerTest resource. integer No - -
type - string No - -

Status.queryOptions

Back to PathAnalyzerTest status

PathAnalyzerTestQueryOptions defines nested fields for PathAnalyzerTest.QueryOptions.

Field Description Type Required Default Enum
isBiDirectionalAnalysis If true, a path analysis is done for both the forward and reverse routes. boolean No - -

Status.sourceEndpoint

Back to PathAnalyzerTest status

PathAnalyzerTestSourceEndpoint defines nested fields for PathAnalyzerTest.SourceEndpoint.

Field Description Type Required Default Enum
address The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object. string No - -
instanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. string No - -
jsonData - string No - -
listenerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. string No - -
loadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer. string No - -
networkLoadBalancerId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. string No - -
psaId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. string No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). string No - -
type - string No - -
vlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). string No - -
vnicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. string No - -

Status.status

Back to PathAnalyzerTest status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to PathAnalyzerTest status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to PathAnalyzerTest status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to PathAnalyzerTest status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -