| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- |
| | Generated by Apache Maven Doxia at 2021-06-15 |
| | Rendered using Apache Maven Stylus Skin 1.5 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <title>Apache Hadoop 3.3.1 – </title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20210615" /> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="http://hadoop.apache.org/" id="bannerLeft"> |
| <img src="http://hadoop.apache.org/images/hadoop-logo.jpg" alt="" /> |
| </a> |
| <a href="http://www.apache.org/" id="bannerRight"> |
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" /> |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| <div class="xleft"> |
| <a href="http://www.apache.org/" class="externalLink">Apache</a> |
| > |
| <a href="http://hadoop.apache.org/" class="externalLink">Hadoop</a> |
| > |
| <a href="../index.html">Apache Hadoop Project Dist POM</a> |
| > |
| <a href="index.html">Apache Hadoop 3.3.1</a> |
| > |
| |
| </div> |
| <div class="xright"> <a href="http://wiki.apache.org/hadoop" class="externalLink">Wiki</a> |
| | |
| <a href="https://gitbox.apache.org/repos/asf/hadoop.git" class="externalLink">git</a> |
| | |
| <a href="http://hadoop.apache.org/" class="externalLink">Apache Hadoop</a> |
| |
| | Last Published: 2021-06-15 |
| | Version: 3.3.1 |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| <h5>General</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../index.html">Overview</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/SingleCluster.html">Single Node Setup</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/ClusterSetup.html">Cluster Setup</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/CommandsManual.html">Commands Reference</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/FileSystemShell.html">FileSystem Shell</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/Compatibility.html">Compatibility Specification</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/DownstreamDev.html">Downstream Developer's Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/AdminCompatibilityGuide.html">Admin Compatibility Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/InterfaceClassification.html">Interface Classification</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/filesystem/index.html">FileSystem Specification</a> |
| </li> |
| </ul> |
| <h5>Common</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/CLIMiniCluster.html">CLI Mini Cluster</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/FairCallQueue.html">Fair Call Queue</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/NativeLibraries.html">Native Libraries</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/Superusers.html">Proxy User</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/RackAwareness.html">Rack Awareness</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/SecureMode.html">Secure Mode</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/ServiceLevelAuth.html">Service Level Authorization</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/HttpAuthentication.html">HTTP Authentication</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/CredentialProviderAPI.html">Credential Provider API</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-kms/index.html">Hadoop KMS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/Tracing.html">Tracing</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/UnixShellGuide.html">Unix Shell Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/registry/index.html">Registry</a> |
| </li> |
| </ul> |
| <h5>HDFS</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">Architecture</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html">User Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSCommands.html">Commands Reference</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html">NameNode HA With QJM</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html">NameNode HA With NFS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ObserverNameNode.html">Observer NameNode</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/Federation.html">Federation</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ViewFs.html">ViewFs</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ViewFsOverloadScheme.html">ViewFsOverloadScheme</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html">Snapshots</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsEditsViewer.html">Edits Viewer</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsImageViewer.html">Image Viewer</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsPermissionsGuide.html">Permissions and HDFS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html">Quotas and HDFS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/LibHdfs.html">libhdfs (C API)</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/WebHDFS.html">WebHDFS (REST API)</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-hdfs-httpfs/index.html">HttpFS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ShortCircuitLocalReads.html">Short Circuit Local Reads</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/CentralizedCacheManagement.html">Centralized Cache Management</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsNfsGateway.html">NFS Gateway</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html">Rolling Upgrade</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ExtendedAttributes.html">Extended Attributes</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/TransparentEncryption.html">Transparent Encryption</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsMultihoming.html">Multihoming</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html">Storage Policies</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/MemoryStorage.html">Memory Storage Support</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/SLGUserGuide.html">Synthetic Load Generator</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSErasureCoding.html">Erasure Coding</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HDFSDiskbalancer.html">Disk Balancer</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsUpgradeDomain.html">Upgrade Domain</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsDataNodeAdminGuide.html">DataNode Admin</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs-rbf/HDFSRouterFederation.html">Router Federation</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/HdfsProvidedStorage.html">Provided Storage</a> |
| </li> |
| </ul> |
| <h5>MapReduce</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html">Tutorial</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredCommands.html">Commands Reference</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduce_Compatibility_Hadoop1_Hadoop2.html">Compatibility with 1.x</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/EncryptedShuffle.html">Encrypted Shuffle</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/PluggableShuffleAndPluggableSort.html">Pluggable Shuffle/Sort</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/DistributedCacheDeploy.html">Distributed Cache Deploy</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/SharedCacheSupport.html">Support for YARN Shared Cache</a> |
| </li> |
| </ul> |
| <h5>MapReduce REST APIs</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredAppMasterRest.html">MR Application Master</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-hs/HistoryServerRest.html">MR History Server</a> |
| </li> |
| </ul> |
| <h5>YARN</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/YARN.html">Architecture</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/YarnCommands.html">Commands Reference</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/CapacityScheduler.html">Capacity Scheduler</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/FairScheduler.html">Fair Scheduler</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceManagerRestart.html">ResourceManager Restart</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceManagerHA.html">ResourceManager HA</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceModel.html">Resource Model</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/NodeLabel.html">Node Labels</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/NodeAttributes.html">Node Attributes</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/WebApplicationProxy.html">Web Application Proxy</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServer.html">Timeline Server</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html">Timeline Service V.2</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/WritingYarnApplications.html">Writing YARN Applications</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/YarnApplicationSecurity.html">YARN Application Security</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/NodeManager.html">NodeManager</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/DockerContainers.html">Running Applications in Docker Containers</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/RuncContainers.html">Running Applications in runC Containers</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/NodeManagerCgroups.html">Using CGroups</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/SecureContainer.html">Secure Containers</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/ReservationSystem.html">Reservation System</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/GracefulDecommission.html">Graceful Decommission</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/OpportunisticContainers.html">Opportunistic Containers</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/Federation.html">YARN Federation</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/SharedCache.html">Shared Cache</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/UsingGpus.html">Using GPU</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/UsingFPGA.html">Using FPGA</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/PlacementConstraints.html">Placement Constraints</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/YarnUI2.html">YARN UI2</a> |
| </li> |
| </ul> |
| <h5>YARN REST APIs</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/WebServicesIntro.html">Introduction</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/ResourceManagerRest.html">Resource Manager</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html">Node Manager</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServer.html#Timeline_Server_REST_API_v1">Timeline Server</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_v.2_REST_API">Timeline Service V.2</a> |
| </li> |
| </ul> |
| <h5>YARN Service</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/Overview.html">Overview</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/QuickStart.html">QuickStart</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/Concepts.html">Concepts</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/YarnServiceAPI.html">Yarn Service API</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/ServiceDiscovery.html">Service Discovery</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-site/yarn-service/SystemServices.html">System Services</a> |
| </li> |
| </ul> |
| <h5>Hadoop Compatible File Systems</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-aliyun/tools/hadoop-aliyun/index.html">Aliyun OSS</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-aws/tools/hadoop-aws/index.html">Amazon S3</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-azure/index.html">Azure Blob Storage</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-azure-datalake/index.html">Azure Data Lake Storage</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-openstack/index.html">OpenStack Swift</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-cos/cloud-storage/index.html">Tencent COS</a> |
| </li> |
| </ul> |
| <h5>Auth</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-auth/index.html">Overview</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-auth/Examples.html">Examples</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-auth/Configuration.html">Configuration</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-auth/BuildingIt.html">Building</a> |
| </li> |
| </ul> |
| <h5>Tools</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-streaming/HadoopStreaming.html">Hadoop Streaming</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-archives/HadoopArchives.html">Hadoop Archives</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-archive-logs/HadoopArchiveLogs.html">Hadoop Archive Logs</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-distcp/DistCp.html">DistCp</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-gridmix/GridMix.html">GridMix</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-rumen/Rumen.html">Rumen</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-resourceestimator/ResourceEstimator.html">Resource Estimator Service</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-sls/SchedulerLoadSimulator.html">Scheduler Load Simulator</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/Benchmarking.html">Hadoop Benchmarking</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-dynamometer/Dynamometer.html">Dynamometer</a> |
| </li> |
| </ul> |
| <h5>Reference</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/release/">Changelog and Release Notes</a> |
| </li> |
| <li class="none"> |
| <a href="../../api/index.html">Java API docs</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/UnixShellAPI.html">Unix Shell API</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/Metrics.html">Metrics</a> |
| </li> |
| </ul> |
| <h5>Configuration</h5> |
| <ul> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/core-default.xml">core-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs/hdfs-default.xml">hdfs-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-hdfs-rbf/hdfs-rbf-default.xml">hdfs-rbf-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/mapred-default.xml">mapred-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-yarn/hadoop-yarn-common/yarn-default.xml">yarn-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-kms/kms-default.html">kms-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-hdfs-httpfs/httpfs-default.html">httpfs-default.xml</a> |
| </li> |
| <li class="none"> |
| <a href="../../hadoop-project-dist/hadoop-common/DeprecatedProperties.html">Deprecated Properties</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> |
| </a> |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <!--- |
| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| --> |
| <ul> |
| |
| <li>Public/Stable/Replaceable |
| <ul> |
| |
| <li><a href="#hadoop_add_array_param">hadoop_add_array_param</a></li> |
| <li><a href="#hadoop_add_classpath">hadoop_add_classpath</a></li> |
| <li><a href="#hadoop_add_client_opts">hadoop_add_client_opts</a></li> |
| <li><a href="#hadoop_add_colonpath">hadoop_add_colonpath</a></li> |
| <li><a href="#hadoop_add_javalibpath">hadoop_add_javalibpath</a></li> |
| <li><a href="#hadoop_add_ldlibpath">hadoop_add_ldlibpath</a></li> |
| <li><a href="#hadoop_add_param">hadoop_add_param</a></li> |
| <li><a href="#hadoop_add_profile">hadoop_add_profile</a></li> |
| <li><a href="#hadoop_array_contains">hadoop_array_contains</a></li> |
| <li><a href="#hadoop_build_custom_subcmd_var">hadoop_build_custom_subcmd_var</a></li> |
| <li><a href="#hadoop_deprecate_envvar">hadoop_deprecate_envvar</a></li> |
| <li><a href="#hadoop_detect_priv_subcmd">hadoop_detect_priv_subcmd</a></li> |
| <li><a href="#hadoop_java_exec">hadoop_java_exec</a></li> |
| <li><a href="#hadoop_java_setup">hadoop_java_setup</a></li> |
| <li><a href="#hadoop_mkdir">hadoop_mkdir</a></li> |
| <li><a href="#hadoop_need_reexec">hadoop_need_reexec</a></li> |
| <li><a href="#hadoop_os_tricks">hadoop_os_tricks</a></li> |
| <li><a href="#hadoop_sort_array">hadoop_sort_array</a></li> |
| <li><a href="#hadoop_status_daemon">hadoop_status_daemon</a></li> |
| <li><a href="#hadoop_stop_daemon">hadoop_stop_daemon</a></li> |
| <li><a href="#hadoop_stop_secure_daemon">hadoop_stop_secure_daemon</a></li> |
| <li><a href="#hadoop_subcommand_secure_opts">hadoop_subcommand_secure_opts</a></li> |
| <li><a href="#hadoop_translate_cygwin_path">hadoop_translate_cygwin_path</a></li> |
| <li><a href="#hadoop_using_envvar">hadoop_using_envvar</a></li> |
| <li><a href="#hadoop_validate_classname">hadoop_validate_classname</a></li> |
| <li><a href="#hadoop_verify_confdir">hadoop_verify_confdir</a></li> |
| <li><a href="#hadoop_verify_user_perm">hadoop_verify_user_perm</a></li> |
| <li><a href="#hadoop_verify_user_resolves">hadoop_verify_user_resolves</a></li> |
| </ul> |
| </li> |
| <li>Public/Stable/Not Replaceable |
| <ul> |
| |
| <li><a href="#hadoop_abs">hadoop_abs</a></li> |
| <li><a href="#hadoop_add_entry">hadoop_add_entry</a></li> |
| <li><a href="#hadoop_debug">hadoop_debug</a></li> |
| <li><a href="#hadoop_delete_entry">hadoop_delete_entry</a></li> |
| <li><a href="#hadoop_error">hadoop_error</a></li> |
| <li><a href="#hadoop_exit_with_usage">hadoop_exit_with_usage</a></li> |
| <li><a href="#hadoop_populate_workers_file">hadoop_populate_workers_file</a></li> |
| <li><a href="#hadoop_rotate_log">hadoop_rotate_log</a></li> |
| <li><a href="#hadoop_verify_entry">hadoop_verify_entry</a></li> |
| </ul> |
| </li> |
| <li>Public/Evolving/Replaceable |
| <ul> |
| |
| <li><a href="#hadoop_subcommand_opts">hadoop_subcommand_opts</a></li> |
| </ul> |
| </li> |
| <li>Private/Evolving/Replaceable |
| <ul> |
| |
| <li><a href="#hadoop_actual_ssh">hadoop_actual_ssh</a></li> |
| <li><a href="#hadoop_add_common_to_classpath">hadoop_add_common_to_classpath</a></li> |
| <li><a href="#hadoop_add_to_classpath_tools">hadoop_add_to_classpath_tools</a></li> |
| <li><a href="#hadoop_add_to_classpath_userpath">hadoop_add_to_classpath_userpath</a></li> |
| <li><a href="#hadoop_common_worker_mode_execute">hadoop_common_worker_mode_execute</a></li> |
| <li><a href="#hadoop_connect_to_hosts">hadoop_connect_to_hosts</a></li> |
| <li><a href="#hadoop_connect_to_hosts_without_pdsh">hadoop_connect_to_hosts_without_pdsh</a></li> |
| <li><a href="#hadoop_daemon_handler">hadoop_daemon_handler</a></li> |
| <li><a href="#hadoop_do_classpath_subcommand">hadoop_do_classpath_subcommand</a></li> |
| <li><a href="#hadoop_exec_hadooprc">hadoop_exec_hadooprc</a></li> |
| <li><a href="#hadoop_exec_user_hadoopenv">hadoop_exec_user_hadoopenv</a></li> |
| <li><a href="#hadoop_finalize">hadoop_finalize</a></li> |
| <li><a href="#hadoop_finalize_classpath">hadoop_finalize_classpath</a></li> |
| <li><a href="#hadoop_finalize_hadoop_heap">hadoop_finalize_hadoop_heap</a></li> |
| <li><a href="#hadoop_finalize_hadoop_opts">hadoop_finalize_hadoop_opts</a></li> |
| <li><a href="#hadoop_finalize_libpaths">hadoop_finalize_libpaths</a></li> |
| <li><a href="#hadoop_generic_java_subcmd_handler">hadoop_generic_java_subcmd_handler</a></li> |
| <li><a href="#hadoop_import_shellprofiles">hadoop_import_shellprofiles</a></li> |
| <li><a href="#hadoop_parse_args">hadoop_parse_args</a></li> |
| <li><a href="#hadoop_privilege_check">hadoop_privilege_check</a></li> |
| <li><a href="#hadoop_secure_daemon_handler">hadoop_secure_daemon_handler</a></li> |
| <li><a href="#hadoop_setup_secure_service">hadoop_setup_secure_service</a></li> |
| <li><a href="#hadoop_shellprofiles_classpath">hadoop_shellprofiles_classpath</a></li> |
| <li><a href="#hadoop_shellprofiles_finalize">hadoop_shellprofiles_finalize</a></li> |
| <li><a href="#hadoop_shellprofiles_init">hadoop_shellprofiles_init</a></li> |
| <li><a href="#hadoop_shellprofiles_nativelib">hadoop_shellprofiles_nativelib</a></li> |
| <li><a href="#hadoop_start_daemon">hadoop_start_daemon</a></li> |
| <li><a href="#hadoop_start_daemon_wrapper">hadoop_start_daemon_wrapper</a></li> |
| <li><a href="#hadoop_start_secure_daemon">hadoop_start_secure_daemon</a></li> |
| <li><a href="#hadoop_start_secure_daemon_wrapper">hadoop_start_secure_daemon_wrapper</a></li> |
| <li><a href="#hadoop_su">hadoop_su</a></li> |
| <li><a href="#hadoop_verify_logdir">hadoop_verify_logdir</a></li> |
| <li><a href="#hadoop_verify_piddir">hadoop_verify_piddir</a></li> |
| <li><a href="#hadoop_verify_secure_prereq">hadoop_verify_secure_prereq</a></li> |
| </ul> |
| </li> |
| </ul><hr /> |
| <div class="section"> |
| <h2><a name="Public.2FStable.2FReplaceable"></a>Public/Stable/Replaceable</h2> |
| <div class="section"> |
| <h3><a name="hadoop_add_array_param"></a><tt>hadoop_add_array_param</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_array_param envvar appendstring |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add the <tt>appendstring</tt> if <tt>checkstring</tt> is not present in the given array</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_classpath"></a><tt>hadoop_add_classpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_classpath object [before|after] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add a file system object (directory, file, wildcard, …) to the classpath. Optionally provide a hint as to where in the classpath it should go.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = success (added or duplicate)</p> |
| <p>1 = failure (doesn’t exist or some other reason)</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_client_opts"></a><tt>hadoop_add_client_opts</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_client_opts |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Adds the HADOOP_CLIENT_OPTS variable to HADOOP_OPTS if HADOOP_SUBCMD_SUPPORTDAEMONIZATION is false</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_colonpath"></a><tt>hadoop_add_colonpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_colonpath envvar object [before|after] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add a file system object (directory, file, wildcard, …) to the colonpath. Optionally provide a hint as to where in the colonpath it should go. Prior to adding, objects are checked for duplication and check for existence. Many other functions use this function as their base implementation including <tt>hadoop_add_javalibpath</tt> and <tt>hadoop_add_ldlibpath</tt>.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = success (added or duplicate)</p> |
| <p>1 = failure (doesn’t exist or some other reason)</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_javalibpath"></a><tt>hadoop_add_javalibpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_javalibpath object [before|after] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add a file system object (directory, file, wildcard, …) to the Java JNI path. Optionally provide a hint as to where in the Java JNI path it should go.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = success (added or duplicate)</p> |
| <p>1 = failure (doesn’t exist or some other reason)</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_ldlibpath"></a><tt>hadoop_add_ldlibpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_ldlibpath object [before|after] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add a file system object (directory, file, wildcard, …) to the LD_LIBRARY_PATH. Optionally provide a hint as to where in the LD_LIBRARY_PATH it should go.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = success (added or duplicate)</p> |
| <p>1 = failure (doesn’t exist or some other reason)</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_param"></a><tt>hadoop_add_param</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_param envvar checkstring appendstring |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Append the <tt>appendstring</tt> if <tt>checkstring</tt> is not present in the given <tt>envvar</tt></p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_profile"></a><tt>hadoop_add_profile</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_profile shellprofile |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Register the given <tt>shellprofile</tt> to the Hadoop shell subsystem</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_array_contains"></a><tt>hadoop_array_contains</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_array_contains element array |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Check if an array has a given value</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul></div></div> |
| <div class="section"> |
| <h2><a name="a.40returns______0_.3D_yes"></a>@returns 0 = yes</h2></div> |
| <div class="section"> |
| <h2><a name="a.40returns______1_.3D_no"></a>@returns 1 = no</h2> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table> |
| <div class="section"> |
| <h3><a name="hadoop_build_custom_subcmd_var"></a><tt>hadoop_build_custom_subcmd_var</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_build_custom_subcmd_var command subcommand customid |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Build custom subcommand var</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>string</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_deprecate_envvar"></a><tt>hadoop_deprecate_envvar</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_deprecate_envvar oldvar newvar |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Replace <tt>oldvar</tt> with <tt>newvar</tt> if <tt>oldvar</tt> exists.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_detect_priv_subcmd"></a><tt>hadoop_detect_priv_subcmd</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_detect_priv_subcmd command subcommand |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>autodetect whether this is a priv subcmd by whether or not a priv user var exists and if HADOOP_SECURE_CLASSNAME is defined</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>1 = not priv</p> |
| <p>0 = priv</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_java_exec"></a><tt>hadoop_java_exec</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_java_exec command class [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Execute the Java <tt>class</tt>, passing along any <tt>options</tt>. Additionally, set the Java property -Dproc_<tt>command</tt>.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_java_setup"></a><tt>hadoop_java_setup</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_java_setup |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Configure/verify ${JAVA_HOME}</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>may exit on failure conditions</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_mkdir"></a><tt>hadoop_mkdir</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_mkdir dir |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Create the directory ‘dir’.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_need_reexec"></a><tt>hadoop_need_reexec</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_need_reexec subcommand |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Verify that ${USER} is allowed to execute the given subcommand.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>1 on no re-exec needed</p> |
| <p>0 on need to re-exec</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_os_tricks"></a><tt>hadoop_os_tricks</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_os_tricks |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Routine to configure any OS-specific settings.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>may exit on failure conditions</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_sort_array"></a><tt>hadoop_sort_array</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_sort_array arrayvar |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Sort an array (must not contain regexps) present in the given array</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_status_daemon"></a><tt>hadoop_status_daemon</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_status_daemon pidfile |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Determine the status of the daemon referenced by <tt>pidfile</tt></p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>(mostly) LSB 4.1.0 compatible status</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_stop_daemon"></a><tt>hadoop_stop_daemon</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_stop_daemon command pidfile |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Stop the non-privileged <tt>command</tt> daemon with that that is running at <tt>pidfile</tt>.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_stop_secure_daemon"></a><tt>hadoop_stop_secure_daemon</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_stop_secure_daemon command daemonpidfile wrapperpidfile |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Stop the privileged <tt>command</tt> daemon with that that is running at <tt>daemonpidfile</tt> and launched with the wrapper at <tt>wrapperpidfile</tt>.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_subcommand_secure_opts"></a><tt>hadoop_subcommand_secure_opts</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_subcommand_secure_opts program subcommand |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add custom (program)_(command)_SECURE_EXTRA_OPTS to HADOOP_OPTS. This <i>does not</i> handle the pre-3.x deprecated cases</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>will exit on failure conditions</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_translate_cygwin_path"></a><tt>hadoop_translate_cygwin_path</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_translate_cygwin_path varnameref [true] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Converts the contents of the variable name <tt>varnameref</tt> into the equivalent Windows path. If the second parameter is true, then <tt>varnameref</tt> is treated as though it was a path list.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_using_envvar"></a><tt>hadoop_using_envvar</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_using_envvar var |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Declare <tt>var</tt> being used and print its value.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_validate_classname"></a><tt>hadoop_validate_classname</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_validate_classname classname |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Verify that a shell command was passed a valid class name</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = success</p> |
| <p>1 = failure w/user message</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_confdir"></a><tt>hadoop_verify_confdir</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_confdir |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Validate ${HADOOP_CONF_DIR}</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>will exit on failure conditions</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_user_perm"></a><tt>hadoop_verify_user_perm</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_user_perm command subcommand |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Verify that ${USER} is allowed to execute the given subcommand.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>return 0 on success</p> |
| <p>exit 1 on failure</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_user_resolves"></a><tt>hadoop_verify_user_resolves</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_user_resolves userstring |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Verify that username in a var converts to user id</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 for success</p> |
| <p>1 for failure</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div></div> |
| <div class="section"> |
| <h2><a name="Public.2FStable.2FNot_Replaceable"></a>Public/Stable/Not Replaceable</h2> |
| <div class="section"> |
| <h3><a name="hadoop_abs"></a><tt>hadoop_abs</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_abs fsobj |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Given a filename or dir, return the absolute version of it This works as an alternative to readlink, which isn’t portable.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 success</p> |
| <p>1 failure</p> |
| <p>stdout abspath</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_entry"></a><tt>hadoop_add_entry</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_entry |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Given variable $1 add $2 to it</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_debug"></a><tt>hadoop_debug</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_debug string |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Print a message to stderr if –debug is turned on</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_delete_entry"></a><tt>hadoop_delete_entry</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_delete_entry |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Given variable $1 delete $2 from it</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_error"></a><tt>hadoop_error</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_error string |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Print a message to stderr</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_exit_with_usage"></a><tt>hadoop_exit_with_usage</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_exit_with_usage exitcode |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Print usage information and exit with the passed <tt>exitcode</tt></p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>This function will always exit.</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_populate_workers_file"></a><tt>hadoop_populate_workers_file</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_populate_workers_file filename |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Set the worker support information to the contents of <tt>filename</tt></p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>will exit if file does not exist</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_rotate_log"></a><tt>hadoop_rotate_log</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_rotate_log filename [number] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Rotates the given <tt>file</tt> until <tt>number</tt> of files exist.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>$? will contain last mv’s return value</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_entry"></a><tt>hadoop_verify_entry</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_entry |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Given variable $1 determine if $2 is in it</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>0 = yes, 1 = no</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Stable </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> No </td></tr> |
| </tbody> |
| </table></div></div> |
| <div class="section"> |
| <h2><a name="Public.2FEvolving.2FReplaceable"></a>Public/Evolving/Replaceable</h2> |
| <div class="section"> |
| <h3><a name="hadoop_subcommand_opts"></a><tt>hadoop_subcommand_opts</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_subcommand_opts program subcommand |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add custom (program)_(command)_OPTS to HADOOP_OPTS. Also handles the deprecated cases from pre-3.x.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>will exit on failure conditions</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Public </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div></div> |
| <div class="section"> |
| <h2><a name="Private.2FEvolving.2FReplaceable"></a>Private/Evolving/Replaceable</h2> |
| <div class="section"> |
| <h3><a name="hadoop_actual_ssh"></a><tt>hadoop_actual_ssh</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_actual_ssh hostname command [...] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Via ssh, log into <tt>hostname</tt> and run <tt>command</tt></p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_common_to_classpath"></a><tt>hadoop_add_common_to_classpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_common_to_classpath |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add the common/core Hadoop components to the environment</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul></div></div> |
| <div class="section"> |
| <h2><a name="a.40returns______1_on_failure.2C_may_exit"></a>@returns 1 on failure, may exit</h2></div> |
| <div class="section"> |
| <h2><a name="a.40returns______0_on_success"></a>@returns 0 on success</h2> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table> |
| <div class="section"> |
| <h3><a name="hadoop_add_to_classpath_tools"></a><tt>hadoop_add_to_classpath_tools</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_to_classpath_tools module |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Run libexec/tools/module.sh to add to the classpath environment</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_add_to_classpath_userpath"></a><tt>hadoop_add_to_classpath_userpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_add_to_classpath_userpath |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Add the user’s custom classpath settings to the environment</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_common_worker_mode_execute"></a><tt>hadoop_common_worker_mode_execute</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_common_worker_mode_execute commandarray |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Utility routine to handle –workers mode</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_connect_to_hosts"></a><tt>hadoop_connect_to_hosts</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_connect_to_hosts command [...] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Connect to ${HADOOP_WORKERS} or ${HADOOP_WORKER_NAMES} and execute command.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_connect_to_hosts_without_pdsh"></a><tt>hadoop_connect_to_hosts_without_pdsh</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_connect_to_hosts_without_pdsh command [...] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Connect to ${HADOOP_WORKER_NAMES} and execute command under the environment which does not support pdsh.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_daemon_handler"></a><tt>hadoop_daemon_handler</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_daemon_handler [start|stop|status|default] command class daemonpidfile daemonoutfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Manage a non-privileged daemon.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_do_classpath_subcommand"></a><tt>hadoop_do_classpath_subcommand</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_do_classpath_subcommand [parameters] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Perform the ‘hadoop classpath’, etc subcommand with the given parameters</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>will print & exit with no params</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_exec_hadooprc"></a><tt>hadoop_exec_hadooprc</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_exec_hadooprc |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Read the user’s settings. This provides for users to run Hadoop Shell API after system bootstrap</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_exec_user_hadoopenv"></a><tt>hadoop_exec_user_hadoopenv</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_exec_user_hadoopenv |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Read the user’s settings. This provides for users to override and/or append hadoop-env.sh. It is not meant as a complete system override.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_finalize"></a><tt>hadoop_finalize</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_finalize |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Finish all the remaining environment settings prior to executing Java. This is a wrapper that calls the other <tt>finalize</tt> routines.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_finalize_classpath"></a><tt>hadoop_finalize_classpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_finalize_classpath |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Finish Java classpath prior to execution</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_finalize_hadoop_heap"></a><tt>hadoop_finalize_hadoop_heap</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_finalize_hadoop_heap |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Finish Java heap parameters prior to execution</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_finalize_hadoop_opts"></a><tt>hadoop_finalize_hadoop_opts</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_finalize_hadoop_opts |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Finish configuring Hadoop specific system properties prior to executing Java</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_finalize_libpaths"></a><tt>hadoop_finalize_libpaths</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_finalize_libpaths |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Finish Java JNI paths prior to execution</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_generic_java_subcmd_handler"></a><tt>hadoop_generic_java_subcmd_handler</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_generic_java_subcmd_handler |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Handle subcommands from main program entries</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_import_shellprofiles"></a><tt>hadoop_import_shellprofiles</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_import_shellprofiles |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Import shellprofile.d content</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_parse_args"></a><tt>hadoop_parse_args</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_parse_args [parameters, typically "$@"] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>generic shell script option parser. sets HADOOP_PARSE_COUNTER to set number the caller should shift</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_privilege_check"></a><tt>hadoop_privilege_check</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_privilege_check |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Check if we are running with priv by default, this implementation looks for EUID=0. For OSes that have true priv separation, this should be something more complex</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>1 = no priv</p> |
| <p>0 = priv</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_secure_daemon_handler"></a><tt>hadoop_secure_daemon_handler</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_secure_daemon_handler [start|stop|status|default] command class daemonpidfile daemonoutfile wrapperpidfile wrapperoutfile wrappererrfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Manage a privileged daemon.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_setup_secure_service"></a><tt>hadoop_setup_secure_service</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_setup_secure_service |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>None</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_shellprofiles_classpath"></a><tt>hadoop_shellprofiles_classpath</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_shellprofiles_classpath |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Apply the shell profile classpath additions</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_shellprofiles_finalize"></a><tt>hadoop_shellprofiles_finalize</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_shellprofiles_finalize |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Apply the shell profile final configuration</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_shellprofiles_init"></a><tt>hadoop_shellprofiles_init</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_shellprofiles_init |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Initialize the registered shell profiles</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_shellprofiles_nativelib"></a><tt>hadoop_shellprofiles_nativelib</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_shellprofiles_nativelib |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Apply the shell profile native library additions</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_start_daemon"></a><tt>hadoop_start_daemon</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_start_daemon command class pidfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Start a non-privileged daemon in the foreground.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_start_daemon_wrapper"></a><tt>hadoop_start_daemon_wrapper</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_start_daemon_wrapper command class pidfile outfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Start a non-privileged daemon in the background.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_start_secure_daemon"></a><tt>hadoop_start_secure_daemon</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_start_secure_daemon command class daemonpidfile daemonoutfile daemonerrfile wrapperpidfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Start a privileged daemon in the foreground.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_start_secure_daemon_wrapper"></a><tt>hadoop_start_secure_daemon_wrapper</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_start_secure_daemon_wrapper command class daemonpidfile daemonoutfile wrapperpidfile warpperoutfile daemonerrfile [options] |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Start a privileged daemon in the background.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_su"></a><tt>hadoop_su</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_su user commandstring |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Execute a command via su when running as root if the given user is found or exit with failure if not. otherwise just run it. (This is intended to be used by the start-<i>/stop-</i> scripts.)</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>exitstatus</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_logdir"></a><tt>hadoop_verify_logdir</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_logdir |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>None</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_piddir"></a><tt>hadoop_verify_piddir</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_piddir |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>None</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>Nothing</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div> |
| <div class="section"> |
| <h3><a name="hadoop_verify_secure_prereq"></a><tt>hadoop_verify_secure_prereq</tt></h3> |
| <ul> |
| |
| <li>Synopsis</li> |
| </ul> |
| |
| <div> |
| <div> |
| <pre class="source">hadoop_verify_secure_prereq |
| </pre></div></div> |
| |
| <ul> |
| |
| <li>Description</li> |
| </ul> |
| <p>Verify that prerequisites have been met prior to excuting a privileged program.</p> |
| <ul> |
| |
| <li>Returns</li> |
| </ul> |
| <p>This routine may exit.</p> |
| <table border="0" class="bodyTable"> |
| <thead> |
| |
| <tr class="a"> |
| <th align="left"> Classification </th> |
| <th align="left"> Level </th></tr> |
| </thead><tbody> |
| |
| <tr class="b"> |
| <td align="left"> Audience </td> |
| <td align="left"> Private </td></tr> |
| <tr class="a"> |
| <td align="left"> Stability </td> |
| <td align="left"> Evolving </td></tr> |
| <tr class="b"> |
| <td align="left"> Replaceable </td> |
| <td align="left"> Yes </td></tr> |
| </tbody> |
| </table></div></div> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| © 2008-2021 |
| Apache Software Foundation |
| |
| - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>. |
| Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
