|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| NETWORK_PRIVATE-IP(1) | OCI CLI Command Reference | NETWORK_PRIVATE-IP(1) |
NAME
network_private-ip -DESCRIPTION
A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private IP.Note: For information about IPv6 addresses, see Ipv6 <https://docs.cloud.oracle.com/api/#/en/iaas/latest/Ipv6/>.
Each instance has a primary private IP that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can’t remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated.
You can add secondary private IPs to a VNIC after it’s created. For more information, see the privateIp operations and also IP Addresses <https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm>.
Note: Only ListPrivateIps <https://docs.cloud.oracle.com/api/#/en/iaas/latest/PrivateIp/ListPrivateIps> and GetPrivateIp <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/private-ip/get.html> work with primary private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP’s properties come from the values you specify in CreateVnicDetails <https://docs.cloud.oracle.com/api/#/en/iaas/latest/CreateVnicDetails/> when calling either LaunchInstance <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance/launch.html> or AttachVnic <https://docs.cloud.oracle.com/api/#/en/iaas/latest/VnicAttachment/AttachVnic>. To update the hostname for a primary private IP, you use UpdateVnic <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vnic/update.html>.
PrivateIp objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the PrivateIp object. Also see Vlan <https://docs.cloud.oracle.com/api/#/en/iaas/latest/Vlan>.
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies <https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm>.
AVAILABLE COMMANDS
- delete
- get
- list
- update
delete
- Description
- Usage
- Required Parameters
- Optional Parameters
- Global Parameters
- Examples
Description
Unassigns and deletes the specified private IP. You must specify the object’s OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm>. The private IP address is returned to the subnet’s pool of available addresses.This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated.
Important: If a secondary private IP is the target of a route rule <https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip>, unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.
Usage
oci network private-ip delete [OPTIONS]
Required Parameters
- --private-ip-id [text]
The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the private IP or IPv6.
Optional Parameters
- --force
Perform deletion without prompting for confirmation.
- --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
- --if-match [text]
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
Global Parameters
Use oci --help for help on global parameters.--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v
Examples
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.
export private_ip_id=<substitute-value-of-private_ip_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/private-ip/delete.html#cmdoption-private-ip-id
oci network private-ip delete --private-ip-id $private_ip_id
get
- Description
- Usage
- Required Parameters
- Optional Parameters
- Global Parameters
- Examples
Description
Gets the specified private IP. You must specify the object’s OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm>. Alternatively, you can get the object by using ListPrivateIps <https://docs.cloud.oracle.com/api/#/en/iaas/latest/PrivateIp/ListPrivateIps> with the private IP address (for example, 10.0.3.3) and subnet OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm>.Usage
oci network private-ip get [OPTIONS]
Required Parameters
- --private-ip-id [text]
The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the private IP or IPv6.
Optional Parameters
- --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
Global Parameters
Use oci --help for help on global parameters.--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v
Examples
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.
export private_ip_id=<substitute-value-of-private_ip_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/private-ip/get.html#cmdoption-private-ip-id
oci network private-ip get --private-ip-id $private_ip_id
list
- Description
- Usage
- Optional Parameters
- Global Parameters
- Examples
Description
Lists the PrivateIp <https://docs.cloud.oracle.com/api/#/en/iaas/latest/PrivateIp/> objects based on one of these filters:If you’re listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.
Usage
oci network private-ip list [OPTIONS]
Optional Parameters
- --all
Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.
- --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
- --ip-address [text]
An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3
- --limit [integer]
For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.
Example:
50
- --page [text]
For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.
- --page-size [integer]
When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.
- --subnet-id [text]
The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the subnet.
- --vlan-id [text]
The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the VLAN.
- --vnic-id [text]
The OCID of the VNIC.
Global Parameters
Use oci --help for help on global parameters.--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v
Examples
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.
oci network private-ip list
update
- Description
- Usage
- Required Parameters
- Optional Parameters
- Global Parameters
- Examples
Description
Updates the specified private IP. You must specify the object’s OCID. Use this operation if you want to:To move a secondary private IP to another VNIC, use the bcms network vnic assign-private-ip command with the –unassign-if-already-assigned switch.
This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use UpdateVnic <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vnic/update.html>.
Usage
oci network private-ip update [OPTIONS]
Required Parameters
- --private-ip-id [text]
The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the private IP or IPv6.
Optional Parameters
- --defined-tags [complex type]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm>.
Example:
{"Operations": {"CostCenter": "42"}}
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
- --display-name [text]
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- --force
Perform update without prompting for confirmation.
- --freeform-tags [complex type]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm>.
Example:
{"Department": "Finance"}
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
- --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
- --hostname-label [text]
The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP’s fully qualified domain name (FQDN) (for example, bminstance-1 in FQDN bminstance-1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 <https://tools.ietf.org/html/rfc952> and RFC 1123 <https://tools.ietf.org/html/rfc1123>.
For more information, see DNS in Your Virtual Cloud Network <https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm>.
Example:
bminstance-1
- --if-match [text]
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
Global Parameters
Use oci --help for help on global parameters.--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v
Examples
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.
export private_ip_id=<substitute-value-of-private_ip_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/private-ip/update.html#cmdoption-private-ip-id
oci network private-ip update --private-ip-id $private_ip_id
AUTHOR
OracleCOPYRIGHT
2016, 2022, Oracle| May 17, 2022 | 3.9.1 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.