OCI Utilities

Usage

oci-compartmentid [-h | --help]

Usage

Expanding the Root Partition of an Instance

To expand the root partition of the instance:

1. Use the lsblk command to confirm the OS has identified the new size of the boot volume.

   For example:

   lsblk
   NAME               MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
   sda                  8:0    0  100G  0 disk
   ├─sda1               8:1    0  100M  0 part /boot/efi
   ├─sda2               8:2    0    1G  0 part /boot
   └─sda3               8:3    0 98.9G  0 part
     ├─ocivolume-root 252:0    0 88.9G  0 lvm  /
     └─ocivolume-oled 252:1    0   10G  0 lvm  /var/oled
   sdb                  8:16   0   70G  0 disk
   

   If the disk volume isn't the expected size, run the commands to rescan the boot volume. See Rescanning the Disk for Volumes Attached to Linux-Based Instances.

2. Run the oci-growfs utility with the y option to answer "yes" to all prompts.

   sudo /usr/libexec/oci-growfs -y

   For example:

   $ sudo /usr/libexec/oci-growfs -y
   Volume Group: ocivolume 
   Mountpoint Data
   
   ---------------
   
   mountpoint: /
   
   source: /dev/mapper/ocivolume-root
   
   filesystem type: xfs
   
   source size: 58.9G
   
   type: lvm
   
   size: 58.9G
   
   physical devices: ['/dev/sda3']
   
   physical volumes: ['/dev/sda', '/dev/sda']
   
   partition number: ['3']
   
   volume group name: ocivolume
   
   volume group path: /dev/ocivolume/root
   
   Partition dry run expansion "/dev/sda3" succeeded.
   
   CHANGE: partition=3 start=2304000 old: size=144496607 end=146800606 new: size=207411167 end=209715166 
   
   Partition expand expansion "/dev/sda3" succeeded.
   update-partition set to true
   FLOCK: try exec open fd 9, on failure exec exits this program
   FLOCK: /dev/sda: obtained exclusive lock
   resizing 3 on /dev/sda using resize_sfdisk_gpt
   209715200 sectors of 512. total size=107374182400 bytes
   ## sfdisk --unit=S --dump /dev/sda
   label: gpt
   label-id: DEC7F1D7-BEBD-4622-9B47-8ADF594E82FD
   device: /dev/sda
   unit: sectors
   first-lba: 34
   last-lba: 209715166
   
   /dev/sda1 : start=        2048, size=      204800, type=C12A7328-F81F-11D2-BA4B-00A0C93EC93B, uuid=CEB6C9AA-4543-4CBF-A44E-D75D7BDDC644, name="EFI System Partition"
   /dev/sda2 : start=      206848, size=     2097152, type=0FC63DAF-8483-4772-8E79-3D69D8477DE4, uuid=340A48CC-18ED-4C1A-AAD7-90CDB8E0B600
   /dev/sda3 : start=     2304000, size=   144496607, type=E6D6D379-F507-44C2-A23C-238F2A3DF928, uuid=8BB84AB7-F5DF-47F1-B630-21442C9102C1
   padding 33 sectors for gpt secondary header
   max_end=209715166 tot=209715200 pt_end=146800606 pt_start=2304000 pt_size=144496607
   resize of /dev/sda returned 0.
   FLOCK: /dev/sda: releasing exclusive lock
   
   CHANGED: partition=3 start=2304000 old: size=144496607 end=146800606 new: size=207411167 end=209715166
   
   Extending /dev/sda3 succeeded.
   Device /dev/sda3 extended successfully.
   Logical volume /dev/ocivolume/root extended successfully.
   

For information about the oci-growfs utility options, see Common OCI Utility Options.

Prerequisite

Install the OCI Utilities on the minimal instance. For more information, see Installing the OCI Utilities.

Conversion Types

The oci-image-expand utility provides two types of Oracle Linux Minimal instance conversions:

• Default: Restores default Oracle Linux platform systemd services, diagnostic packages, cloud configuration settings, and configures and enables swap on the instance. Restoring default platform functionality doesn't increase instance boot time. This conversion type is always applied by the oci-image-expand utility.

• Reboot Required: Restores default Oracle Linux platform functionality, as described in the Default conversion type, and restores one or more of the following user-selectable features:

  • Enable SELinux - Restores SELinux enforcing mode.
  • Enable Kdump - Adds kdump capability and regeneration of kdump initramfs.
  • Enable Ksplice - Installs Ksplice and enables the Ksplice service. For information about using Ksplice, see Oracle Ksplice for Zero-Downtime Updates and Oracle Linux Ksplice User's Guide.

  Choosing any of these selectable features increases instance boot time and requires a reboot to take effect.

The oci-image-expand utility log files are located at: /var/log/oci-image-expand.log

Usage

oci-image-expand [-h | --help]

Restoring Default Platform Image Functionality

To restore default Oracle Linux platform image functionality to the Oracle Linux Minimal instance:

Run the oci-image-expand utility and press Enter at the prompt, without making any selections.

For example:

$ /usr/libexec/oci-image-expand
Please select the set of reboot required functions, if any
Selecting a function transitions from not selected [ ] to selected [+] or vice versa
 
[ ] 0) All reboot options

[ ] 1) Enable SELinux

[ ] 2) Enable Kdump

[ ] 3) Enable Ksplice
  
Select the desired options using their number (again to uncheck, ENTER when done):
ENTER

Restoring Reboot Required Platform Image Functionality

To restore Oracle Linux platform image functionality that requires an instance reboot to take effect:

Usage

oci-instanceid [-h | --help]

Usage

oci-iscsi-config [subcommand] [-h | --help]

Subcommands

The oci-iscsi-config utility has the following subcommands.

For a training video that shows how to use the oci-iscsi-config utility, see Using OCI Utilities for Managing iSCSI Storage for Oracle Cloud Infrastructure Instances in the Oracle Linux Training Station.

For information about the oci-iscsi-config utility option, see Common OCI Utility Options.

Displaying iSCSI Configurations

The oci-iscsi-config show subcommand lists the iSCSI devices and iSCSI information for the instance. This subcommand works with the ocid daemon to monitor device creation and deletion through the Console, CLI, or the API, and automatically discovers those changes.

If the ocid daemon isn't running, the subcommand requires root privileges.

Usage

To display a list of all devices attached to the instance:

1. Run the oci-iscsi-config show subcommand.

   sudo oci-iscsi-config show

   For example:

   $ sudo oci-iscsi-config show
   Currently attached iSCSI devices:
             Volume name           |Attached device| Size |
   --------------------------------------------------------
            mor-demo-bv20          |      sdb      | 50G  |
   Block volumes information:
                 Name              | Size |          Attached to           |              OCID              |
   ----------------------------------------------------------------------------------------------------------
            mor-demo-bv30          | 50GB |               -                |ocid1.volume.oc1.OCID|
   

2. Optionally use the --details and --no-truncate options with the oci-iscsi-config show subcommand to display more detailed information that isn't shortened in the output:

   sudo oci-iscsi-config show --details --no-truncate

   For example:

   $ sudo oci-iscsi-config show --details --no-truncate
   Currently attached iSCSI devices:
                Target                       |          Volume name           |          Volume OCID                       | Persistent portal  |   Current portal   |Session State|Attached device| Size |
   ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
   iqn.2015-12.com.oracleiaas:exampleuniqueID|         mor-demo-bv20          |ocid1.volume.oc1.iad.OCID  |  172.16.10.4:3260  |  172.16.10.4:3260  |  LOGGED_IN  |      sdb      | 50G  |
   
   Block volumes information:
                 Name              | Size |          Attached to           |              OCID                        |     IQN      | Compartment |Availability domain|
   ------------------------------------------------------------------------------------------------------------------------------------------------------------
            mor-demo-bv30          | 50GB |               -                |ocid1.volume.oc1.iad.OCID|      -       | virtdoc.dev  |DSdu:US-ASHBURN-AD-3|
   

3. Optionally change the output presentation to be more readable by using the --output-mode option with the oci-iscsi-config show subcommand:

   sudo oci-iscsi-config show --output-mode mode

   For example, to display the output presentation in text mode:

   $ sudo oci-iscsi-config show --output-mode text
   Currently attached iSCSI devices
   Volume name: mor-demo-bv20
   Attached device: sdb
   Size: 50G
   
   Block volumes information
   Name: mor-demo-bv30
   Size: 50GB
   Attached to: -
   OCID: ocid1.volume.oc1.iad..OCID

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Creating and Attaching a New Volume

Use the oci-iscsi-config create subcommand to create and attach a block volume to an instance. This subcommand requires the OCI SDK for Python to be installed and configured. For more information about the OCI SDK, see Software Development Kits and Command Line Interface.

This subcommand requires root privileges.

Usage

oci-iscsi-config create [-S | --size size] [-v | --volume-name name] [--attach-volume] [-c | --chap] [-h | --help]

To create and attach a volume, use the oci-iscsi-config create utility with the -S, --volume-name, and --attach-volume options:

sudo oci-iscsi-config create -S size --volume-name=name --attach-volume

For example, to create and attach a volume that's 70 GB in size to the instance, with the volume name mor-demo-by70:

$ sudo oci-iscsi-config create -S 70 --volume-name=mor-demo-by70 --attach-volume
Creating a new 70 GB volume
Volume name=mor-demo-by70 created
Attaching the volume to this instance
Attaching iSCSI device
iscsiadm attach Result: command executed successfully

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Attaching an Existing Volume

Use the oci-iscsi-config attach subcommand to attach an existing block volume to the instance and make the volume available to the system. The OCI SDK for Python is required for selecting volumes using their OCID. For more information about the OCI SDK, see Software Development Kits and Command Line Interface.

This subcommand requires root privileges.

Usage

oci-iscsi-config attach [-I | --iqns IQN] [-O | --ocids OCID] [-u | --username name] [-p | --password password] [-c | --chap] [-h | --help]

To attach a specific block volume to the instance:

$ sudo oci-iscsi-config attach --iqns iqn.2015-12.com.oracleiaas:IQN

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Synchronizing a Volume

Use the oci-iscsi-config sync subcommand to attach available block devices to the instance and perform sync operations. The subcommand requires root privileges.

Usage

oci-iscsi-config sync [-a | --apply] [-y | --yes] [-h | --help]

To attach available block devices to the instance and synchronize the changes with OCI, use the oci-iscsi-config sync subcommand with the --apply option:

sudo oci-iscsi-config sync --apply

For example:

$ sudo oci-iscsi-config sync --apply
Attaching the volume to this instance
Attaching iSCSI device
iscsiadm attach Result: command executed successfully

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Detaching a Volume

Use the oci-iscsi-config detach subcommand to detach a device with the given IQN (a unique ID assigned to a device). If the volume (or any partition of the volume) is mounted, this option tries to unmount it first.

This subcommand requires root privileges.

Usage

oci-iscsi-config detach [-I | --iqns IQN] [-f | --force] [-h | --help]

To detach a specific device from the instance, use the oci-iscsi-config detach subcommand with the -I option:

sudo oci-iscsi-config detach -I IQN

For example:

$ sudo oci-iscsi-config detach -I  iqn.2015-12.com.oracleiaas:IQN
Detaching volume mor-demo-bv70 (iqn.2015-12.com.oracleiaas:IQN)
Volume [iqn.2015-12.com.oracleiaas:oracleiaas:IQN] is detached
Updating detached volume cache file: ['iqn.2015-12.com.oracleiaas:oracleiaas:IQN']

To view the IQN or OCID of the volume you want detached, use the oci-iscsi-config show subcommand. For information, see Displaying iSCSI Configurations.

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Deleting a Volume

To delete a block storage volume with the given OCID, use the oci-iscsi-config destroy subcommand.

Usage

oci-iscsi-config destroy [-O | --ocids OCID] [-y | --yes] [-h | --help]

To delete a specific block volume from the instance, use the oci-iscsi-config-destroy subcommand with the -O option:

sudo oci-iscsi-config destroy -O OCID

For example:

$ sudo oci-iscsi-config destroy -O ocid1.volume.oc1.OCID
WARNING: the volume(s) will be destroyed.  This is irreversible.  Continue?
y
Volume [ocid1.volume.oc1.iad.OCID] is destroyed

You can view the OCID of the volume by using the oci-iscsi-config show utility subcommand. For information, see Displaying iSCSI Configurations.

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Usage

Getting All Metadata For the Instance

To view all metadata for the instance, run the oci-metadata utility with no options:

sudo oci-metadata

For example:

$ sudo oci-metadata
Instance details:
  Display Name: my-example-instance
  Region: phx - us-phoenix-1 (Phoenix, AZ, USA)
  Canonical Region Name: us-phoenix-1
  Availability Domain: cumS:PHX-AD-1
  Fault domain: FAULT-DOMAIN-3
  OCID: ocid1.instance.oc1.phx.OCID
  Compartment OCID: ocid.compartment.oc1..OCID
  Instance shape: VM.Standard2.1
  Image ID: ocid1.image.oc1.phx.OCID
  Created at: 1569529065596
  state: Running
  agentConfig:
    managementDisabled: False
    monitoringDisabled: False
  Instance Metadata:
    ssh_authorized_keys: example-key
Networking details:
  VNIC OCID: ocid1.vnic.oc1.phx.OCID
  VLAN Tag: 2392
  Private IP address: 10.0.0.16
  MAC address: 02:00:17:03:D8:FE
  Subnet CIDR block: 10.0.0.0/24
  Virtual router IP address: 10.0.0.1

Getting Specific Metadata For the Instance

To view instance metadata for a specified key, use the --get option with the oci-metadata utility:

sudo oci-metadata --get key

For example, to view only the state of the compute instance:

$ sudo oci-metadata --get state
Instance details:
Instance state: Running

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Usage

oci-network-config [subcommand] [-q | --quiet] [-h | --help]

Subcommands

The oci-network-config utility has the following subcommands.

Displaying the Current Network Configuration

The oci-network-config show subcommand shows information about the VNICs configured on the instance. You can view the current network configuration, such as the provisioned VNICs and current IP configurations for the instance. VNICs that aren't yet configured are marked with ADD, and IP configurations that no longer have an associated VNIC are marked with DELETE.

The output for this command is the default action if the oci-network-config utility is entered without any options.

Usage

oci-network-config show [--output-mode mode] [-I | --include item] [-X | --exclude item] [--details] [--no-truncate] [-h | --help]

To display the current network configuration:

sudo oci-network-config show

For example:

$ sudo oci-network-config show 
Network configuration
 State | Link | Status |  IP address |        VNIC        |        MAC        |
------------------------------------------------------------------------------
   -   | ens3 |   UP   | 10.2.20.254 |  hostname_ipv6_01  | 02:00:17:01:30:D5 |
  ADD  | ens4 |   UP   | 10.2.10.121 | vnic20220912090629 | 02:00:17:01:A9:0E |


Operating System level network configuration:
CONFIG      ADDR          SUBNET     BITS   VIRTROUTER      NS    IND      IFACE     VLTAG     VLAN    STATE        MAC                                                VNIC ID                                          
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  -     10.2.20.254     10.2.20.0     24    10.2.20.1       -      2        ens3      3181      -        UP  02:00:17:01:30:D5 ocid1.vnic.oc1.uk-london-1.VNIC_OCID  
 ADD    10.2.10.121     10.2.10.0     24    10.2.10.1       -      3        ens4      1435      -        UP  02:00:17:01:A9:0E ocid1.vnic.oc1.uk-london-1.VNIC_OCID  

To configure VNICs that aren't yet configured (labeled ADD), and delete IP addresses that don't have any associated VNICs, use the oci-network-config config subcommand. For more information, see Configuring VNICs.

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Creating and Attaching a VNIC

Use the oci-network-config attach-vnic subcommand to create and attach a VNIC to an instance. You can assign a public or private IP address to the new VNIC with this subcommand.

Usage

oci-network-config attach-vnic [-I | --ip-address ip_address] [-ipv4 | --ipv4] [-ipv6 | --ipv6] [-i | --nic-index index] [--subnet subnet] [-n | --name name] [--assign-public-ip] [-h | --help]

To create a VNIC and attach the VNIC to an instance, use the oci-network-config attach-vnic subcommand with the -n option:

sudo oci-network-config attach-vnic -n name

For example, to create a VNIC named ex-demo-inst-10 and attach the VNIC to the instance:

$ sudo oci-network-config attach-vnic -n ex-demo-inst-10
creating VNIC: 10.102.119.140

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

# sudo oci-network-config attach-vnic --ipv6
Attaching a vnic with a primary ipv6 address is not yet supported by OCI.

Configuring VNICs

The oci-network-config configure subcommand adds IP configuration for VNICs that aren't configured and deletes the IP configuration of VNICs that are no longer provisioned. This command synchronizes the instance IP configuration with the current OCI provisioning.

Usage

oci-network-config configure [-n | --namespace format] [-r | --start-sshd] [-I | --include item] [-X | --exclude item] [-h | --help]

To configure all the VNICs on the instance:

sudo oci-network-config configure

For example:

$ sudo oci-network-config configure
Configured 

To configure the VNICs on the instance, except for a specific VNIC, use the oci-network-config configure subcommand with the -X option:

sudo oci-network-config configure -X VNIC_OCID

For example:

$ sudo oci-network-config configure -X VNIC_OCID
Configured 

You can confirm the VNICs are configured by running the oci-network-config show subcommand. After configuration, no ADD or DELETE labels will be displayed in the output, unless you chose to exclude a VNIC from being configured. For more information, see Displaying the Current Network Configuration.

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Displaying Configured VNICs

The oci-network-config show-vnics subcommand shows information about VNICs configured on the instance.

Usage

oci-network-config show-vnics [--output-mode mode] [--details] [--ocid OCID] [--name name] [--ip-address primary_ip] [--no-truncate] [-h | --help]

To show information about VNICs configured on the instance:

sudo oci-network-config show-vnics

For example:

$ sudo oci-network-config show-vnics
VNICs Information:
              Name              |   Private IP  |                                           OCID                                           |       MAC       |
--------------------------------------------------------------------------------------------------------------------------------------------------------------
        ex-demo-inst-10         |10.102.119.140|     ocid1.vnic.oc1.iad.OCID                                                    |00:00:17:02:CC:CB|
        mor-demoinst-10         |10.102.118.251|     ocid1.vnic.oc1.iad.OCID                                                    |02:00:17:02:C6:B2|

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Displaying All Configured VNICS

Use the oci-network-config show-vnics-all subcommand to view detailed information about all VNICs configured on this instance.

Usage

oci-network-config show-vnics-all [--output-mode mode] [-h | --help]

To display all VNICs configured on the instance:

sudo oci-network-config show-vnics-all

For example:

# sudo oci-network-config show-vnics-all
Virtual Network Interface Information:
        Name        |  Private IP |        MAC        | Config |                                           OCID                                          | Primary  |      Subnet      | Subnet cidr  |       State        | NIC  |   Public IP    |
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  hostname_ipv6_01  | 10.2.20.254 | 02:00:17:01:30:D5 |   -    | ocid1.vnic.oc1.iad.OCID                                                |   True   | hostname_uk02_02 | 10.2.20.0/24 | AVAILABLE-ATTACHED |  -   | 140.238.76.113 |
      IP address details      
                      Private IP               |                                             OCID                                             |      
      ----------------------------------------------------------------------------------------------------------------------------------------      
                     10.2.20.254               | ocid1.privateip.oc1.iad.OCID |      
      
      
 vnic20220912090629 | 10.2.10.121 | 02:00:17:01:A9:0E |   -    | ocid1.vnic.oc1.iad.OCID                                               |    -     | hostname_uk02_01 | 10.2.10.0/24 | AVAILABLE-ATTACHED |  -   |       -        |
      IP address details      
                      Private IP               |                                             OCID                                             |      
      ----------------------------------------------------------------------------------------------------------------------------------------      
                     10.2.10.121               | ocid1.privateip.oc1.iad.OCID |      
       2603:c020:c003:3a10:b64c:8f35:7f9e:7e87 |   ocid1.ipv6.oc1.iad.OCID    |      

For information about the oci-network-config show-vnics-all options, see Common OCI Utility Options.

Adding a Secondary Address

Use the oci-network-config add-secondary-addr utility to add a secondary private IP address with the specified IPv4 or IPv6 address to an existing VNIC.

Usage

oci-network-config add-secondary-addr [-ipv4 | --ipv4] [-ipv6 | --ipv6] [-I | --ip-address ip_address] [-O | --ocid OCID] [-h | --help]

To add a private secondary IP address, in this case an IPv6 address, to an existing VNIC, use the oci-network-config add-secondary-addr subcommand with the --ipv6 and --ocid options:

sudo oci-network-config add-secondary-addr --ipv6 --ocid OCID

For example:

$ sudo oci-network-config add-secondary-addr --ipv6 --ocid ocid1.vnic.oc1.iad.OCID
Provisioning secondary private IPv6: 2603:c020:c003:3a10:b64c:8f35:7f9e:7e87
IP 2603:c020:c003:3a10:b64c:8f35:7f9e:7e87 has been assigned to vnic ocid1.vnic.oc1.iad.OCID

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Deleting the IP Configuration for Provisioned Secondary VNICs

Use the oci-network-config unconfigure subcommand to delete all IP configuration for provisioned secondary VNICs (except the ones explicitly excluded). The primary VNIC can't be deleted.

Usage

oci-network-config unconfigure [-I | --include item] [-X | --exclude item] [-h | --help]

To delete all IP configuration for provisioned secondary VNICs, use the oci-network-config unconfigure subcommand:

sudo oci-network-config unconfigure

For example:

$ sudo oci-network-config unconfigure
Unconfigured 

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Removing a Secondary IPv6 Address

Use the oci-network-config remove-secondary-addr subcommand to remove a secondary private IP address with the specified IPv4 or IPv6 address from an existing VNIC.

Usage

oci-network-config remove-secondary-addr [-I | --ip-address ip_address] [-h | --help]

To remove a private secondary IPv6 address from an existing VNIC, use the oci-network-config remove-secondary-addr subcommand with the -I option:

sudo oci-network-config remove-secondary-addr -I ip_address

For example, to remove the secondary IPv6 address, 2603:c020:c003:3a10:b64c:8f35:7f9e:7e87, from an existing VNIC:

$ sudo oci-network-config remove-secondary-addr -I 2603:c020:c003:3a10:b64c:8f35:7f9e:7e87
Deconfigure secondary private IP 2603:c020:c003:3a10:b64c:8f35:7f9e:7e87

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Detaching a VNIC

Use the oci-network-config detach-vnic subcommand to detach and delete the VNIC with the specific OCID or IP address from the instance. This subcommand can be used to remove the assigned IP address from an existing VNIC. However, the primary VNIC can't be detached. Any secondary private IP addresses associated with the VNIC are also deleted.

Usage

oci-network-config detach-vnic [-I | --ip-address ip_address] [-O | --ocid OCID] [-h | --help]

To detach a VNIC from the instance, use the oci-network-config detach-vnic subcommand with the --ocid option:

sudo oci-network-config detach-vnic --ocid OCID

For example, to detach a VNIC with a specific VNIC OCID from the instance:

$ sudo oci-network-config detach-vnic --ocid ocid1.vnic.oc1.iad.OCID
Detaching VNIC 10.2.10.121 [ocid1.vnic.oc1.iad.OCID]
VNIC [ocid1.vnic.oc1.iad.OCID] is detached.

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Usage

oci-network-inspector [-C | --compartment OCID] [-N | --vcn OCID] [-h | --help]

Displaying a Detailed Report for a Specific VCN

To display a detailed report for a specific VCN, run the oci-network-inspector utility and use the -N option to specify the VCN OCID:

sudo oci-network-inspector -N OCID

For example:

$ sudo oci-network-inspector -N ocid1.compartment.oc1..OCID

Compartment: KVM_workspace (ocid1.compartment.oc1..OCID)

  vcn  : uk_02 (ocid1.vcn.oc1..OCID)
    Security List: Default Security List for uk_02
      Ingress: tcp              0.0.0.0/0:-                       ---:22
      Ingress: icmp             0.0.0.0/0:-                    code-4:type-3
      Ingress: icmp           10.2.0.0/16:-                 code-None:type-3
      Ingress: tcp                   ::/0:-                       ---:22
      Ingress: 58                    ::/0:-                       ---:-
      Egress : all                    ---:-                 0.0.0.0/0:-
      Egress : all                    ---:-                      ::/0:-

    Subnet  : uk02_02 (ocid1.subnet.oc1..OCID)
      ipv4 cidr block : 10.2.20.0/24
      ipv6 cidr block : 2603:c020:c003:3a20::/64
      DNS domain name : gtijskenuk0202.gtijskenuk02.oraclevcn.com
       Security List: Default Security List for uk_02
         Ingress: tcp              0.0.0.0/0:-                       ---:22
         Ingress: icmp             0.0.0.0/0:-                    code-4:type-3
         Ingress: icmp           10.2.0.0/16:-                 code-None:type-3
         Ingress: tcp                   ::/0:-                       ---:22
         Ingress: 58                    ::/0:-                       ---:-
         Egress : all                    ---:-                 0.0.0.0/0:-
         Egress : all                    ---:-                      ::/0:-

      Private IP      : 10.2.20.42(primary)  Host: gtijsken-amd-kvm-lon-flex3-vnicb752
        Vnic            : ocid1.vnic.oc1..OCID (AVAILABLE-ATTACHED)
        Vnic PublicIP   : None
        Instance        : amd_kvm_lon_flex3
          Instance State  : RUNNING
          Instance ocid   : ocid1.instance.oc1..OCID

      ...

Displaying a Detailed Report for a Specific Compartment

To view a detailed network report for a specific compartment, run the oci-network-inspector utility and use the -C option to specify a compartment OCID:

sudo oci-network-inspector -C OCID

For example:

$ sudo oci-network-inspector -C ocid1.compartment.oc1..OCID

Compartment: scottb_sandbox (ocid1.compartment.oc1..OCID)

  vcn: scottb_vcn
    Security List: Default Security List for scottb_vcn
      Ingress: tcp              0.0.0.0/0:-                       ---:22
      Ingress: icmp             0.0.0.0/0:-                    code-4:type-3
      Ingress: icmp           10.0.0.0/16:-                 code-None:type-3
      Ingress: tcp              0.0.0.0/0:80                      ---:80
      Ingress: tcp              0.0.0.0/0:43                      ---:43
      Ingress: tcp              0.0.0.0/0:-                       ---:-
      Egress : all                    ---:-                 0.0.0.0/0:-

     Subnet: Public Subnet cumS:PHX-AD-3 Avalibility domain: cumS:PHX-AD-3
         Cidr_block: 10.0.2.0/24 Domain name: sub99999999999.scottbvcn.oraclevcn.com
       Security List: Default Security List for scottb_vcn
         Ingress: tcp              0.0.0.0/0:-                       ---:22
         Ingress: icmp             0.0.0.0/0:-                    code-4:type-3
         Ingress: icmp           10.0.0.0/16:-                 code-None:type-3
         Ingress: tcp              0.0.0.0/0:80                      ---:80
         Ingress: tcp              0.0.0.0/0:43                      ---:43
         Ingress: tcp              0.0.0.0/0:-                       ---:-
         Egress : all                    ---:-                 0.0.0.0/0:-

     ...

Usage

oci-notify [subcommand] [-h | --help]

Subcommands

The oci-notify utility has the following subcommands.

Configuring a Notifications Service Topic on an Instance

Use the oci-notify config subcommand to write the Notifications service topic OCID to the oci.conf file. After configured, you can publish messages to this configured topic.

By default, the path to the configuration file is /etc/oci-utils/oci.conf. You can override the configuration file path by using the OCI_CONFIG_DIR environment variable.

Usage

oci-notify config notifications_topic_OCID [-h | --help]

To write the OCID of a configured Notifications service topic to the oci.conf file, use the oci-notify config subcommand, and specify the Notifications service topic OCID.

For example:

$ sudo oci-notify config ocid1.onstopic.oc1..OCID

For information about the oci-notify-config utility option, see Common OCI Utility Options.

Publishing a Message to a Topic

With the oci-notify message subcommand, you can publish the contents of a file or a text string with the specified title to the configured topic.

Note: When the message is published, the oci-notify utility prepends the instance name to the subject of the message. For example: instance_name:log messages

Usage

oci-notify message [-t | --title 'message_title'] [-f | --file message_file] [-h | --help]

To send the contents of the /var/log/messages file with the title 'logging messages' to the configured topic, use the --title and --file options with the oci-notify-message subcommand.

For example:

$ sudo oci-notify message --title 'logging messages' --file /var/log/messages

To send a text string to the configured topic, enter a line of text in single quotation marks for the value of the --file option.

For example:

$ sudo oci-notify message --title 'sending a text' --file 'Today is a beautiful day'

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Usage

Displaying the IP Address of the Current Instance

Run the oci-public-ip command with no options to return the IP address of the current instance:

sudo oci-public-ip

For example:

$ sudo oci-public-ip
Public IP address: 203.0.113.2

Displaying the IP Address of Another Instance

To view the public IP address of another instance other than the current instance, use the oci-public-ip utility with the --instance-id option.

sudo oci-public-ip --instance-id OCID

For example:

$ sudo oci-public-ip --instance-id ocid1.instance.oc1.phx.OCID
Public IP address: 203.0.113.2

Viewing a List of STUN Servers

To display a list of STUN servers, use the oci-public-ip utility with the --list-servers option:

sudo oci-public-ip --list-servers

For example:

$ sudo oci-public-ip --list-servers
stun.stunprotocol.org
stun.counterpath.net
stun.voxgratia.org
stun.callwithus.com
stun.ekiga.net
stun.ideasip.com
stun.voipbuster.com
stun.voiparound.com
stun.voipstunt.com

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.

Usage

Viewing All Data About an Attached iSCSI Volume

To view all data about an iSCSI volume attached to the compute instance:

sudo oci-volume-data -k OCID

For example:

$ sudo oci-volume-data -k OCID
             display name: name=oci1-iscsi-volume-1
                     ocid: ocid1.volume.oc1.OCID
                      iqn: iqn.2122-45.com.oracleiaas:IQN
                portal ip: 123.245.6.7
              portal port: 1234
                chap user: None
            chap password: None
      availability domain: DSdu:US-EAST-DOMAIN
              compartment: comparment1
           compartment id: ocid1.compartment.OCID
              attached to: oci-utils-instance
         attachment state: --
                     size: 70GB
                    state: AVAILABLE

Viewing Specific Data About an Attached iSCSI Volume

Optionally use the -k, -p, and -v (value-only) options with the oci-volume-data utility to narrow down what you want displayed for the iSCSI volume:

oci-volume-data -k OCID -p size -v

For example, to display only the size of an iSCSI volume, in this case, 70 GB:

$ oci-volume-data -k ocid1.volume.OCID -p size -v
70GB

Option Details

The following table provides detailed information about options specific to this utility or subcommand. For information about the common options used across OCI utilities, see Common OCI Utility Options.